Pillar Design Library Readme

Storybook configuration.

To run storybook you should Follow these steps

1. Clone repo into folder of your choice
2. Checkout development branch
3. Run npm install
4. Copy the storybook configuration from launch.default.json to new file launch.json
5. Launch storybook
   • VS Code users: Use the run/debug panel in the lefthand toolbar to launch storybook.
     1. Click the Run and Debug icon
     2. Select Storybook from the dropdown at the top & press the play icon
     3. The storybook site will launch in your default web browser.
   • Alternatively/non-VS Code users:
     1. Run npm run storybook
     2. The storybook site will launch in your default web browser.

Interactions Panel can be open by pressing D on your keyboard when focused on a story.

Eslint Configuration

1. install the vscode eslint plugin (by microsoft millions of downloads).
2. open a .js file and open the command palette (ctrl+shift+p)
3. choose ESLINT Show Output channel

Only need to do this once and then its set up and running.

Styleint Configuration

1. install the vscode stylelint plugin.
2. open a .scss file and open the command palette (ctrl+shift+p)
3. errors and warnings should show in the file and the problems tab if there are any.

npm Configuration

1. Go to https://www.npmjs.com/ and create an account with a username and password.
2. Your user must be added to the pillarbiosci Origization (Ask Marc About invite email)
3. Run npm login
4. login with your username and password.
5. Run npm whoami to confirm you are logged in.
6. Go to https://www.npmjs.com/~<your user name>/tokens
7. create access token.
8. create a .env file in the root directory and add NPM_TOKEN=<your access token>

Build Pacakge and Publish to npm.

This is mostly automated now. All you need to do prior to opening a pull request is bump the version (which will also be automated soon)

npm version patch // (for development merge) or npm version minor // (for master merge)

---This is automated, only run if needed---

1. In package.json increment the version by 0.0.1
2. Run rm -rf ./node_modules; npm install
3. Run rm -rf ./dist; npm run build The ./dist folder now contains a build from your current branch.
4. Run npm init --scope=@pillarbiosci first time only.
5. Run npm publish