summaryrefslogtreecommitdiffstats
path: root/api/README.md
blob: cee58868f0f4ddd98137ceb8ecc91e8b75113c6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Api

## Develop

* Assumes you have `git clone`'d the repositiory.

### Deps and Dev Env

* Developed on `python 3.10.1`
* Setting up a `venv`
* ensure `django 4` is installed
* `cd /api/`
* `django startproject api`
* Ensure deps are in order. `pip install -r requirements.txt`
* `source .env` (called by `settings.py`)

## Config

Primaril refers to the envars and configs defined in `settings.py`.

Such as:

* added library declaration
* Authentication middleware
* Storage of static and media files
* Access origin control
* Logging
* etc..