[x] Reference the open issue that the pull request addresses
[-] (not needed) 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.
[ ] Address comments on code and resolve requested changes
[ ] Merge own code
Description
Issue: #276
To provide a more complete description of the project and to give new developers guidance about how to build and edit the project, the README.md is edited witht he suggested content
Brief description of solution
Three parts of the README were edited as directed:
Replaced the first paragraph with the suggested text
Under the section "Quickstart for developers"
Full front-end editing walkthrough steps were added
Back-end connecting and interfacing steps were added
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: #276
To provide a more complete description of the project and to give new developers guidance about how to build and edit the project, the README.md is edited witht he suggested content
Brief description of solution
Three parts of the README were edited as directed: