Crisis Coach Assignment Tool

This project contains a web app to assist Crisis first responders with assigning a coach to a new member.

This project was bootstrapped with Create React App.

Documentation

Documentation is available here.

Setup

These instructions assume the development environment is Ubuntu on Windows Subsystem for Linux (WSL), though should be easily adaptable to other Ubuntu installations.

1. Clone this repository.
2. Set up the Yarn development environment:
   1. Install nodejs and NPM using these instructions.
   2. Install the Yarn package manager using the instructions that appear near the end of the output of the previous step.
   3. Run yarn install from the root directory of your clone.
3. Set up a Python virtual environment:
   1. Run python3 -m venv .venv
   2. And source .venv/bin/activate
   3. And finally pip3 install -r requirements.txt
4. Create configuration needed for AWS:
   1. Add the following new section to ~/.aws/config.

      [profile amplify]
      region=eu-west-2
      

   2. Add the following new sections to ~/.aws/credentials, obtaining the values from one of the development team.

      [amplify]
      aws_access_key_id=...
      aws_secret_access_key=...
      
      [crisis-deploy]
      aws_access_key_id=...
      aws_secret_access_key=...
      

5. Setup the AWS Amplify environment by running ./setup-amplify.

Run The App

The following two commands launch a local development instance of the app. Use two separate shells or launch the first command in the background.

1. flask run (must be run in the Python venv)
2. yarn start

The second command should open http://localhost:3000 in your browser. The page will automatically reload if you make edits. You will also see any lint errors in the console.

Other Commands

In the project directory, you can run:

yarn test

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

yarn build

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.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

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

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify