od-design readme

Project setup

yarn install

Lints and fixes files

yarn lint

Running Storybook

yarn build-storybook

yarn serve-storybook

This opens up localhost:6006. If you are running this on the workspace container of the OpenDialog Dev Environment, port 6006 is exposed for this reason.

Local Dev

Before publishing to NPM, you can use this package locally in an instance of OpenDialog by running the following (all from within the OpenDialog Dev Environment workspace container):

• In /var/www/opendialog-design-system run yarn link. This makes the package available locally
• In /var/www/opendialog run yarn link @opendialogai/opendialog-design-system-pkg. This links the local package
• Remove @opendialogai/opendialog-design-system-pkg from the dependencies in OpenDialog's package.json (if there) and run yarn install
• Finally run yarn run dev or yarn watch which will automatically rebuild any changes made in this package

Assets

The -s .public directive has been added to the storybook serve command. This will serve all the assets with the .public directory and make them publicly available for your components

Releasing and publishing to NPM

Auth

The scripts/publish.sh script will use the .npmrc file that expects an env with the name NPM_TOKEN to be present

Customize configuration

See Configuration Reference.