diff --git a/README.md b/README.md index 546ae5c3..f25eae28 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ python manage.py migrate ```bash python manage.py seed ``` -- Create a superuser: +- Create a superuser (optional): ```bash python manage.py createsuperuser ``` @@ -60,11 +60,23 @@ python manage.py seed $ docker-compose down ``` +### Reinstall backend +- Shut down the app (if running): +```bash +$ docker-compose down +``` +- Delete docker instances (WARNING: delete all docker instances): +```bash +$ docker volume prune +``` +- Repeat steps starting from [`Getting Started > Activate virtualenv`](https://github.com/CodeForPhilly/prevention-point#back-end) + ### Front-end - Make sure you have [`node (>=10.15.3)`](https://nodejs.org/en/) and [`yarn (>=1.15.2)`](https://yarnpkg.com/en/docs/install) installed - From the project's root directory, `cd frontend` - Run `yarn` to install dependencies - Run `yarn dev` and navigate to `localhost:1234` + - Default username / password: admin / password123 For more information on the front-end please see the [front-end README](./frontend/readme) @@ -76,6 +88,10 @@ This project implements the [Scripts To Rule Them All](https://github.com/github * `script/setup` — Run after `script/server` to initialize local database with seed data * `script/update` — Run after changing code or switching branches to refresh server +## Merges + +Once your branch is ready to be merged, request merge approval from one other user. After approval is received, proceed to merge the branch. + Other tools ## Links [Wiki](https://github.com/CodeForPhilly/prevention-point/wiki)