diff --git a/README.md b/README.md index 2420e79..a877ae6 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,27 @@ Skeleton of a backend Django App. apps/ app_one/ apputils/ + misc.py + .py + ... migrations/ + ... models/ + .py + .py + ... serializers/ + .py + .py + ... tests/ + .py + .py + ... views/ + .py + .py + ... urls.py project_name/ settings/ @@ -25,3 +41,18 @@ utils/ - Each package is located inside the apps package. - Each model, serializer, view is defined in a separate .py file. + +## Docker + +The app is intended to be run (but not exclusively) in a Docker container. +There is a `docker-compose` and a `Makefile` to execute several useful actions. + +e.g. (Initialization): + +Clone the repo and execute: + +```shell +$ make test +``` + +The docker-compose file will build an image and setup a database, then run the dummy tests. Now you can start building your app!