Browse Source

Update developer guide

pull/1837/head
Hironsan 2 years ago
parent
commit
40113d8217
4 changed files with 8 additions and 0 deletions
  1. 8
      docs/developer_guide.md
  2. BIN
      docs/images/developer_guide/architecture_docker.png
  3. BIN
      docs/images/developer_guide/architecture_docker_compose.png
  4. BIN
      docs/images/developer_guide/architecture_python_package.png

8
docs/developer_guide.md

@ -51,6 +51,10 @@ The architecture of the `docker-compose.prod.yml` is as follows:
![](images/developer_guide/architecture_docker_compose.png) ![](images/developer_guide/architecture_docker_compose.png)
On the other hand, the one of the `Dockerfile` is as follows:
![](images/developer_guide/architecture_docker.png)
## frontend ## frontend
The `frontend/` directory contains frontend code. The `frontent` directory structure follows [Nuxt.js](https://ru.nuxtjs.org) one. See the [Nuxt.js documentation](https://nuxtjs.org/guide/directory-structure/) in details. The `frontend/` directory contains frontend code. The `frontent` directory structure follows [Nuxt.js](https://ru.nuxtjs.org) one. See the [Nuxt.js documentation](https://nuxtjs.org/guide/directory-structure/) in details.
@ -66,3 +70,7 @@ The `tools` directory contains some shell scripts. They are mainly used in Docke
| prod-celery.sh | This script is used to run celery in `docker-compose.prod.yml`. | | prod-celery.sh | This script is used to run celery in `docker-compose.prod.yml`. |
| prod-django.sh | This script is used to run gunicorn in `docker-compose.prod.yml`. In addition, create roles, superuser, and migrate. | | prod-django.sh | This script is used to run gunicorn in `docker-compose.prod.yml`. In addition, create roles, superuser, and migrate. |
| run.sh | This script is used in `Dockerfile`. After creating roles and superuser, run gunicorn and celery. | | run.sh | This script is used in `Dockerfile`. After creating roles and superuser, run gunicorn and celery. |
## Architecture of Python package
![](images/developer_guide/architecture_python_package.png)

BIN
docs/images/developer_guide/architecture_docker.png

Before After
Width: 651  |  Height: 512  |  Size: 61 KiB

BIN
docs/images/developer_guide/architecture_docker_compose.png

Before After
Width: 1241  |  Height: 971  |  Size: 151 KiB Width: 1161  |  Height: 701  |  Size: 135 KiB

BIN
docs/images/developer_guide/architecture_python_package.png

Before After
Width: 723  |  Height: 341  |  Size: 46 KiB
Loading…
Cancel
Save