Maximo Asset Monitor - Device library search

Note

• Add or update a file in the /src/devices/ folder with the specific version number. You can generate the export file using export_devices_csv.py management command.
• Add a link to the newly added file in src/constants/globalContants.js
• Push the code changes to github. This repositary auto deploys the storybook changes into https://ibm-watson-iot.github.io/maximo-asset-monitor-device-library-search

Prerequisites

• Node.js - the required version is specified in the .nvmrc
  • If you're on macOS or using WSL on Windows, we recommend using nvm as your version manager for Node.
• Git
• if you don't have yarn on your MAC Machine then run brew install yarn

You'll also need a code editor to make changes. There are many to choose from but we suggest to use VSCode.

Install dependencies

# install the dependencies
yarn install

Build and start the development server

# run the server
yarn start

Open http://localhost:3000 with your browser to see the result.

Adding a dependency

# To add dependencies to the project
yarn add <packageName>

Do not use npm install.

Storybook

Start the storybook

# run the storybook
yarn storybook

Open http://localhost:6006 with your browser to see the result.

Build the storybook

# Build the storybook which generate storybook-static folder
yarn build-storybook

Deploy the storybook to git hub page

• Once we have storybook-static folder we can publish the storybook to github pages by running below script
• This script will push the content of storybook-static folder into the gh-pages branch of the git repo.
• Git repo details need to be added in homepage properties of package.json file

yarn deploy-storybook