chore: updates readme

master
nicolas 2 years ago
parent afbf1ee220
commit d6f005e8d1

@ -8,11 +8,27 @@ Skeleton of a backend Django App.
apps/ apps/
app_one/ app_one/
apputils/ apputils/
misc.py
<some utils filename>.py
...
migrations/ migrations/
...
models/ models/
<my model>.py
<another model>.py
...
serializers/ serializers/
<my serializer>.py
<anotoher serializer>.py
...
tests/ tests/
<my test file>.py
<anotoher test file>.py
...
views/ views/
<my view>.py
<anotoher view>.py
...
urls.py urls.py
project_name/ project_name/
settings/ settings/
@ -25,3 +41,18 @@ utils/
- Each package is located inside the apps package. - Each package is located inside the apps package.
- Each model, serializer, view is defined in a separate .py file. - 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!

Loading…
Cancel
Save