Skip to content

Commit

Permalink
add command to start the api and a little bit of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chris48s committed Sep 5, 2024
1 parent ac2a572 commit f71864e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,4 @@ collectstatic = "python manage.py collectstatic -c --noinput"
pytest = "pytest"
coveralls = "coveralls"
migratedb = "python manage.py migrate --noinput"
start = "bash -c \"(cd api_endpoints/v1_postcode_lookup/ && uvicorn app:app --reload)\""
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,18 @@
This section assumes a working python 3.8 environment with Pipenv installed.

* `cp ec_api/settings/local.py.example ec_api/settings/local.py`
* Install Python dependencies: `pipenv install --dev`
* Install Python dependencies:
* `pipenv install --dev`
* `pip install -r api_endpoints/v1_postcode_lookup/requirements.txt`
* Run the test suite: `pytest`
* Run lint checks: `ruff .`
* Auto-format: `ruff format .`

## Run application

- Frontend: `./mange.py runserver`
- API: `pipenv run start`

## Pre-commit

Using a pre-commit hook is suggested when working on this project to catch
Expand Down

0 comments on commit f71864e

Please sign in to comment.