Getting Started
Dependencies
| Dependency | Version | Install | Description |
|---|---|---|---|
| nvm | Any version | https://github.com/nvm-sh/nvm | Node Version Manager |
| Yarn | > 1.22.18 | https://yarnpkg.com/lang/en/docs/install | Node Package Manager |
Environment Variables
Copy the contents of .env.sample. into .env.development.local for local development and .env.production.local for
production builds and deployment. Reach out to someone on the team for more information.
Install and Switch Node Version
nvm install // only required if you don't already have the correct version of node install via nvm
nvm use // switch to the correct version of node. Reads from the .nvmrc file
Install NPM Dependencies Using Yarn
yarn install // install dependencies
Run The App
yarn start // runs the dashboard locally
Available Commands
| Command | Description |
|---|---|
| yarn install | Install dependencies |
| yarn start | Start development server |
| yarn build | builds client for production deployment |
| yarn test | Run test suite |
| yarn lint | Run files against linter |
| yarn prettier:format | Auto format all code with prettier |
| yarn prettier:check | Check code formatting with prettier |
| yarn commit | Run a commit prompt - uses commitizen |
| yarn storybook | Runs Storybook |
| yarn storybook:build | Builds storybook for deployment |
| yarn storybook:deploy | Deploy storybook |
| yarn deploy | Deploy to firebase |
| yarn convert-svgs-to-components | Convert SVG icons in ./src/views/components/atoms/Svgs to React components |
| yarn convert-icons-to-components | Convert icons in ./src/views/components/atoms/Svgs to React components |
| yarn cy:open | Open Cypress UI |
| yarn cy:run | Run Cypress tests in headless mode |
| yarn cy:ci | Run Cypress tests in TeamCity CI server |
| yarn cy:run-visuals | Run cypress visual tests in headless mode |
| yarn cy:update-visuals | Update visual regression test baseline iamges |