Development.md

Running against development/staging

You can start the addon's Storybook with the CHROMATIC_BASE_URL set, as you would with the Chromatic CLI:

CHROMATIC_BASE_URL=https://www.staging-chromatic.com yarn storybook

If running with the index URL set in against the addon's Storybook, we'll also update the configured project identifier appropriately. If you are running in dev, you can either tweak your database to have the correct project identifier/token, or you can alter development.config.json and run with:

CHROMATIC_BASE_URL=https://www.dev-chromatic.com yarn storybook

Running against an outside Storybook

If you want to test the addon with an actual project, you can install it from NPM as usual -- we publish canaries for each PR.

You can also link the addon in the usual ways. One way via Yarn is:

yarn link /path/to/addon-visual-tests/repo

Once you do that, the project will use your local version of the addon.

When running, you can connect the addon to staging/dev similarly, although you'll need to configure the project identifier/token manually.

CHROMATIC_BASE_URL=https://www.staging-chromatic.com yarn storybook

Running a local version of the Chromatic CLI

You can link a local copy of the Chromatic CLI for testing the build workflow through the addon:

yarn link /path/to/chromatic-cli/repo