Skip to content

Commit 3d62c6d

Browse files
committed
Add docker and project task runner to readme
1 parent f5605c2 commit 3d62c6d

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -413,8 +413,17 @@ And don't despair if don't get the python setup working on the first try. No one
413413

414414
## Running / Development
415415

416+
For a live reloading on code changes.
417+
416418
* `pipenv run dev`
417-
* Visit your app at [http://localhost:8000](http://localhost:8000).
419+
420+
Without live reloading.
421+
422+
* `pipenv run start`
423+
424+
Visit your app at [http://localhost:8000](http://localhost:8000).
425+
426+
Alternatively run our API with Docker.
418427

419428
### Running Tests
420429
> [pytest](https://docs.pytest.org/en/latest/)
@@ -446,7 +455,22 @@ invoke generate-reqs
446455

447456
[Pipfile.lock](./Pipfile.lock) will be automatically updated during `pipenv install`.
448457

449-
### Building
458+
### Docker
459+
460+
Our Docker image is based on [tiangolo/uvicorn-gunicorn-fastapi/](https://hub.docker.com/r/tiangolo/uvicorn-gunicorn-fastapi/).
461+
462+
```bash
463+
invoke docker --build
464+
```
465+
466+
Run with `docker run` or `docker-compose`
467+
468+
### Invoke
469+
470+
Additional developer commands can be run by calling them with the [python `invoke` task runner](http://www.pyinvoke.org/).
471+
```bash
472+
invoke --list
473+
```
450474

451475
### Deploying
452476

0 commit comments

Comments
 (0)