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.

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

Add extra documentation covering environment variables and running tests #226

Merged
merged 1 commit into from
Nov 19, 2017
Merged
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,10 +492,27 @@ pip install -r requirements.txt
At this point your virtual environment should have everything it needs to run both the sample `project` and
`silk` successfully.

Before running, you must set the `DB` and `DB_NAME` environment variables:

```bash
export DB=sqlite3
export DB_NAME=db.sqlite3
```

For other combinations, check [`.travis.yml`](./.travis.yml).

Now from the root of the sample `project` directory start the django server

```bash
python manage.py runserver
```

#### Running the tests

```bash
cd project
./tests/test_migrations.sh
python manage.py test --noinput
```

Happy profiling!