upshot-ui

The official design system used in Upshot.

Install dependencies

yarn

Start storybook server

yarn start

Fix code formatting

yarn lint

Export module

yarn build

Link with Upshot UIs

In development, you will likely want to link this repo with the one containing the Upshot UIs (Analytics, Answer, etc.) Follow the latest guide in the upshot-web repo.

Publish on NPM

1. Checkout the latest main branch.

git checkout main
git pull

2. Bump the version and build.

yarn
yarn version
yarn build

3. Publish to npm (note: you will need to be logged into an account associated with the org.)

If you're publishing for the first time, generate an access token from npmjs.com then add to your bash profile via:

export NPM_TOKEN=ACCESS_TOKEN

To publish to npm, use:

npm publish

Shortcuts

Update the current branch and start development

yarn pulld

Checkout to the main branch of the repo, update, and start development

yarn maind

Routing

To enable client-side routing from Next.js, use <Link> (@UI/Link) in place of <a> with a linkComponent prop to receive the next/link router.