Skip to content

Commit

Permalink
Merge pull request #2 from districtr/anna-doc-tweak
Browse files Browse the repository at this point in the history
[DOCS] small README updates
  • Loading branch information
bailliekova authored Jul 20, 2024
2 parents 938d9cd + 6897590 commit 2a644c6
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ To do this on production, run `fly postgres connect -a {{ database-id }}` then t

### Python install

Dependencies are managed with uv as noted in the root README. Follow set-up instructions [there](../README.md#python).
Dependencies are managed with uv as noted in the root README. Follow set-up instructions [there](../README.md#python). Production is on python 3.12.2; a python version >=3.11 is required.

Set-up virtual environment and install dependencies:

1. `uv venv`
1. `source venv/bin/activate` on UNIX machines or `venv\Scripts\activate` on Windows.
1. `source .venv/bin/activate` on UNIX machines or `venv\Scripts\activate` on Windows.
1. `uv pip install -r requirements.txt`

### Postgres set-up
Expand All @@ -79,6 +79,12 @@ Set-up virtual environment and install dependencies:
1. `\q`
1. `alembic upgrade head`

If needed, create a user for yourself.

1. `psql`
1. `\c districtr`
1. `CREATE USER postgres WITH PASSWORD 'make up your own password';`

### Testing

`pytest --cov=app --cov-report=html`
Expand Down

0 comments on commit 2a644c6

Please sign in to comment.