See demo here!

Please also check out CONTRIBUTING.md

• Clone the repository on your machine

git clone <GIT REPOS HERE> [folder name]
cd [folder name]

• Inside the repository, install the necessary packages

npm ci
# as opposed to npm install, which modifies package-lock.json

• Set up your local .env folder

Copy the file pinned to the side of #resilience-app channel to .env.developmentin the git root of this repo.

• Start the local server

npm start

• As you work in the repository, your changes will publish and refresh your local server on the fly.
• To stop the server, use the terminal command Ctrl. + C

When running the app locally, you can test the phone verification sign-up flow by entering any of the phone number / verification code combinations listed below (the leading "1" should be filled in for you):

In the project directory, you can run:

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

{DONT THINK WE ARE MAINTAINING THIS CURRENTLY}

Run the storybook where we can showcase the components in the system write a story

Run this to generate docs in docs/ folder (made with JSDocs). For more info

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

• See Contributing.MD but... Checkout a new branch by choosing a simple name that expresses the individual issue you're addressing

git checkout -b my-feature-28

• Do your work in the branch
• Check that your changes are present by checking the status

git status

• Add your changes to the branch

git add .

• Add a commit message that explains the work that's complete, the way you did it, and any other notes you might want to leave for code reviewers

git commit -m "My feature is now working on the front page. I noticed that there might be a typo in a public function. You'll see the code comment."

• Push your work into the branch origin

git push -u origin my-feature-28

• Create a pull request and assign as reviewer
• Once all issues are addressed and you have at least two approvals, merge your changes to master and deploy.

All commands in one clipboard:

git checkout -b [branch name]
git status
git add .
git commit -m "[commit message]"
git push -u origin [branch name]

Using react-axe as a library to find accessibilty warnings and errors. Please check the console for warnings or errors from react-axe before committing.

• Login into Heroku with Email and Password:

heroku login

• Add the Heroku branch to your local machine:

heroku git:remote -a <heroku app name>

• Develop as per normal, branching and merging to master.
• Once you are happy with master, push the changes into the Heroku branch:

git push heroku master

• This also runs all of the build and deployment commands, so it may take a moment, but once it's complete, the live link should be updated.