Crisis App

Project prerequisites

To run this project locally first you will need to install:

• Yarn

Project setup

Set the FontAwesome Pro key before installing for the first time, (or you'll get a 402 error)

Get the FontAwesome Pro Key from here: https://firemap.atlassian.net/wiki/spaces/DC/pages/7045831/FontAwesome+Pro+Key

export FONTAWESOME_NPM_AUTH_TOKEN=XXX
scripts/set_the_bloody_fa_pro_key.sh # if ur on windows just replace !!!FA PRO KEY HERE!!! manually in .npmrc
yarn install
git checkout -- .npmrc # to reset npmrc so you don't commit it

Note: this is Derwent's key who has a license, just don't share this elsewhere or make this repo public. (oh shit it's public, oh well.)

Compiles and hot-reloads for development

yarn run serve

Compiles and minifies for production

yarn run build

Run your tests

yarn run test

Lints and fixes files

yarn run lint

Customize configuration

See Configuration Reference.

Contributing

• Please pick a card from the current sprint in JIRA.
• If you create a new ticket in JIRA and it's a development ticket, remember to set the development label.
• We are doing feature branching of the develop branch,
• your branch name should be CAD-XX (the JIRA ticket ID)
• All commits should pass yarn lint before pushing (or the pipeline will fail)
• Commit messages should ideally be [CAD-XX]<GITMOJI> short description of work. E.g.: [CAD-66] 🚲 Bye, SQL!
• GitMojis are awesome but optional Gitmoji reference here and here - please copy the unicode gitmoji from the second guide, not just :emoji:
• When you've submitted a PR, set the status of the ticket to Review and ask for a reviewer
• When someone has merged the PR into develop, check that it passes all of the tests in the pipeline and deploys to prod.
• Once you're happy with how it looks in develop, then you can merge into master.
• Only when you've validated that your feature has made it to prod can you change your card to done.