[x] Reference the open issue that the pull request addresses
[x] Pass code quality checks
spin up docker docker-compose up -d --build
enter api container docker-compose exec api /bin/bash
run api tests make validate
exit container ctrl/command+D or exit
enter web container docker-compose exec web /bin/sh
run front-end tests npm run test or npx jest
lint npm run lint:fix
exit container as above
[x] Request code review
Please allow 36 hours from opening a pull request before merging a pull request- even if it has already received an approving review.
[x] Address comments on code and resolve requested changes
[ ] Merge own code
Description
Issue: #403
Brief description of solution
Rewrites the README to separate out the instructions for downloading code from the npm and Docker install instructions and adds additional information for each of those two method for starting the app.
Includes a note in each of the two references to Trello that use of that tool may change soon.
… instructions
Checklist
docker-compose up -d --build
docker-compose exec api /bin/bash
make validate
ctrl/command+D
orexit
docker-compose exec web /bin/sh
npm run test
ornpx jest
npm run lint:fix
Description
Issue: #403
Brief description of solution Rewrites the README to separate out the instructions for downloading code from the npm and Docker install instructions and adds additional information for each of those two method for starting the app.
Includes a note in each of the two references to Trello that use of that tool may change soon.