Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

clarify README instructions a bit with code blocks #266

Merged
merged 1 commit into from
Apr 15, 2020
Merged

clarify README instructions a bit with code blocks #266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,24 @@ This is a Code for Philly project operating under their code of conduct.
This project implements the [Scripts To Rule Them All](https://github.com/github/scripts-to-rule-them-all) interface for developers:

**Starting Locally**
1. `script/server` — Brings a fully working environment up at [localhost:8080](http://localhost:8080)
2. `script/setup` — Run after `script/server` to initialize local database with seed data

Run the command below to bring a fully working environment up at [localhost:8080](http://localhost:8080).

```
./script/server
```

**Seeding Database with Data**

Run the command below to initialize local database with seed data

```
# this makes sure server is running
./script/server

# adds a test user account, and seed data
./script/setup
```

**Updating Running Version**
* `script/update` — Run after changing code or switching branches to refresh server
Expand Down