XF
/
drugs
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Improve README

This commit is contained in:
Mark Veidemanis 2023-10-17 21:04:07 +01:00
parent f1dd61e228
commit 5169f5033c
Signed by: m
GPG Key ID: 5ACFCEED46C0904F
1 changed files with 5 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,18 +1,13 @@
# Envelope # drugs
Template Django app. DIMAR: An anti-addiction-focused Drug Inventory Management, Administration and Retrospective tool.
## Setting up the environment ## Setting up the environment
Create the virtual environment, enable it, and install the dependencies. Create the virtual environment, enable it, and install the dependencies.
```shell ```shell
$ python3 -m venv env $ python3 -m venv env
$ source env/bin/activate $ source env/bin/activate
(env) $ pip install -r docker/prod/requirements.prod.txt (env) $ pip install -r requirements.txt
```
## Local settings
You'll need to copy the `app/local_settings.example.py` file to `app/local_settings.py`. The project won't start otherwise.
```
$ cp app/local_settings.example.py app/local_settings.py
``` ```
## stack.env ## stack.env
@ -39,26 +34,9 @@ Superuser created successfully.
``` ```
## Running ## Running
The Docker Compose file is located in `docker/docker-compose.prod.yml`. The Docker Compose file is located in `docker-compose.yml`.
There is a shortcut to run it: `make run`. There is a shortcut to run it: `make run`.
## Stopping ## Stopping
To stop the containers, run `make stop`. To stop the containers, run `make stop`.
## Setup
This setup may be different from what you've seen before.
### Uvicorn
There is a Uvicorn worker in the `app` container listening on `/var/run/socks/app.sock`. This is the bit that runs the actual code.
### Nginx
Nginx runs in the `nginx` container and proxies requests to Uvicorn thanks to a mounted and shared directory. No TCP required.
### Pre-start steps
There's a few commands running before start to ensure Django works correctly.
#### Migration
The `migration` container step runs the migrations so you don't need to remember to do it.
#### Collectstatic
The `collectstatic` container step collects all static files from plugins and puts them in the `core/static` folder. This folder is served straight from Nginx without going through Uvicorn.