Storybook

Setup

cd src/SIL.XForge.Scripture/ClientApp
npm install

If you get an error on missing dependencies, run:

cd src/SIL.XForge.Scripture/ClientApp
sudo npx playwright install-deps

Usage

Run:

cd src/SIL.XForge.Scripture/ClientApp
npm run storybook

Or to start storybook without opening your web browser:

cd src/SIL.XForge.Scripture/ClientApp
npm run storybook -- --no-open

If you are having tests fail in chromatic but pass locally in storybook, run storybook in this way:

cd src/SIL.XForge.Scripture/ClientApp
npm run build-storybook && npx http-server -p 6006 ./storybook-static

Run Storybook stories/tests headlessly (you must run storybook first):

cd src/SIL.XForge.Scripture/ClientApp
npm run test-storybook

If you receive an error that "It seems that your Storybook instance is not running at: http://127.0.0.1:6006. Are you sure it's running?", try:

cd src/SIL.XForge.Scripture/ClientApp
npm run test-storybook --url http://localhost:6006

Accessing Storybook

After running Storybook, you can view it via http://localhost:6006/