Dev

• Dev: Contributing, Dev: Issues
• Dev: Style, Dev: Testing, Dev: Pull Requests
• Dev: Server

Getting Started

Run the server like so for local serving on http://localhost:8080/

yarn install
yarn serve

To disable local dev mode, e.g. to make live GitHub API calls

NODE_ENV=production yarn serve

See Dev: Server for all env vars.

Package Scripts

• yarn build build share and cosmos

• yarn build-share just share

• yarn serve

• yarn clean remove /docs

• yarn lint runs lint (eslint)

• yarn test runs unit tests (jest)

• yarn cypress run integration tests

• yarn precommit alias for yarn test && yarn lint, but must run without error for commits to succeed.

• yarn build-cosmos assumes the docs folder is exists and just builds storybook into it (at docs/sb)

• yarn serve-cosmos serves SB, with hot reloading

• yarn cypress-spec run a single test (e.g. yarn cypress-spec cypress/e2e/home/homepage.cy.js)

• yarn cypress-headed run integration tests with browser in headed mode so you can watch and inspect

• yarn cypress-headed-spec run a single test in browser headed mode (e.g. yarn cypress-headed-spec cypress/e2e/home/homepage.cy.js)