Note: On completion of pull request it would deploy to targetted environment and there won't be any extra approval at this stage.
develop -> dev
qa -> qa
main -> uat
prod -> prod/live
- [macOS] Make sure you have brew installed
- Install the latest stable version of Node.js
- Install the latest stable version of Yarn
- Run
yarn install
- Run
yarn start
- Navigate to http://localhost:3000
- Run
yarn install
(if you haven't already) - Run
yarn build
- Run
yarn install
(if you haven't already) - Run
yarn storybook
- Navigate to http://localhost:9001
-
Install 2 packages
- ESLint
- Prettier
-
Settings for each:
-
ESLint should not need changing
-
Prettier:
- Tick ESLint integration
- Tick single quotes
- Tick Bracket spacing
- Tick semicolons
- Print width 100
- Tab width should be 2 spaces
- No trailing commas
- Tick run prettier last
-
-
Setup your public/config.json file.
- The needed keys are in Lastpass.
-
Warning: The current Dev environment points to the staging database & backend, to ease setup and allow testing with apps. Please be careful with the data when you develop.
-
TODO: Setup local dev environment
- I'm trying to use some new standards, because this app was created by someone else's standards.
- Updating the whole codebase would take too much time, so I'm gonna do it slowly, and mostly with new stuff.
- Please keep that in mind when doing a review. Let me know if you see anything odd or that you're not sure about.
Deployment on TEST is handled by CircleCI.
Simply merge your PR into develop
and CircleCI will take care of the rest.
Deployment takes about 5 minutes after merge.
Do NOT manually rebuild the app on develop
Deployment to DEMO is done manually.
To do this, follow this process:
- Merge
develop
intodemo
via a PR. - Pull
demo
locally, update the version number inpackage.json
and runnpm run build
. Commit & Push the resulting changes to thedemo
branch. - On reconnix, in
/home/crest-demo.app-drive.co.uk
, usegit pull
.
Deployment to LIVE is done manually.
First, you have to deploy & test the features on DEMO.
After that, follow this process:
- Merge
demo
intomaster
. - On reconnix, in
/home/crestplanning.co.uk/halo
, usegit pull
. "# halo"