diff options
| author | Pratyush Desai | 2021-12-24 20:08:42 +0530 |
|---|---|---|
| committer | Pratyush Desai | 2021-12-24 20:08:42 +0530 |
| commit | 5564ffb20798d45bf87910feea39bf02b0d2dee4 (patch) | |
| tree | 1a4deea0ecbb582e1efe6eb8cabadb679dccfa42 /api/README.md | |
| parent | 5725181871aab1b84ddb0cbccc7d6f033210c2cb (diff) | |
| download | website-5564ffb20798d45bf87910feea39bf02b0d2dee4.tar.gz website-5564ffb20798d45bf87910feea39bf02b0d2dee4.tar.bz2 website-5564ffb20798d45bf87910feea39bf02b0d2dee4.zip | |
django initdjango
Diffstat (limited to 'api/README.md')
| -rw-r--r-- | api/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/api/README.md b/api/README.md new file mode 100644 index 0000000..cee5886 --- /dev/null +++ b/api/README.md @@ -0,0 +1,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.. |