Skip to content

Commit b2f5114

Browse files
authored
Update README.md
1 parent 429c9d3 commit b2f5114

File tree

1 file changed

+7
-52
lines changed

1 file changed

+7
-52
lines changed

README.md

Lines changed: 7 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -18,62 +18,17 @@ This project would work to migrate all of the disparate data sources into one sy
1818
This is a Code for Philly project operating under their code of conduct.
1919

2020
## Getting Started
21-
### Back-end
2221
- Install [docker-compose](https://docs.docker.com/compose/install/)
23-
- Install [pipenv](https://github.com/pypa/pipenv)
24-
- Install dependencies
25-
```bash
26-
pipenv sync
27-
```
28-
- Activate virtualenv
29-
```bash
30-
pipenv shell
31-
```
32-
- Start the postgres database container
33-
```bash
34-
docker-compose up -d db
35-
```
36-
- Migrate the database
37-
```bash
38-
python manage.py migrate
39-
```
40-
- Seed the database:
41-
```bash
42-
python manage.py seed
43-
```
44-
- Create a superuser:
45-
```bash
46-
python manage.py createsuperuser
47-
```
48-
- Start the app:
49-
```bash
50-
python manage.py runserver 0.0.0.0:8000
51-
```
52-
- Now you can:
53-
- Navigate to the django admin page at localhost:8000/admin
54-
- Connect to the running postgres instance
55-
```bash
56-
$ docker-compose exec db psql -U postgres
57-
```
58-
- Shut down the app:
59-
```bash
60-
$ docker-compose down
61-
```
62-
63-
### Front-end
64-
- Make sure you have [`node (>=10.15.3)`](https://nodejs.org/en/) and [`yarn (>=1.15.2)`](https://yarnpkg.com/en/docs/install) installed
65-
- From the project's root directory, `cd frontend`
66-
- Run `yarn` to install dependencies
67-
- Run `yarn dev` and navigate to `localhost:1234`
68-
69-
For more information on the front-end please see the [front-end README](./frontend/readme)
70-
71-
## Scripts
22+
23+
### Scripts
7224

7325
This project implements the [Scripts To Rule Them All](https://github.com/github/scripts-to-rule-them-all) interface for developers:
7426

75-
* `script/server` — Brings a fully working environment up at [localhost:8080](http://localhost:8080)
76-
* `script/setup` — Run after `script/server` to initialize local database with seed data
27+
**Starting Locally**
28+
1. `script/server` — Brings a fully working environment up at [localhost:8080](http://localhost:8080)
29+
2. `script/setup` — Run after `script/server` to initialize local database with seed data
30+
31+
**Updating Running Version**
7732
* `script/update` — Run after changing code or switching branches to refresh server
7833

7934
Other tools

0 commit comments

Comments
 (0)