From b8457a04d32019917bb20306718fc41d2b77c279 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Tue, 6 Apr 2021 02:40:12 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 4af2e82..fe7f8da 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,33 @@ Django project for dataset collection +## Installation + +The installation method depends on either #1 or #2. + +For now, there is no way to install `sophon`. + +## Configuration + +The following environment variables should be set: + +- `DJANGO_SECRET_KEY`: secret string used in the generation of session cookies +- `DJANGO_DEBUG`: if set, enables Django debug mode +- `DJANGO_DATABASE_HOST`: the hostname of the PostgreSQL database to use +- `DJANGO_DATABASE_NAME`: the name of the PostgreSQL database to use +- `DJANGO_DATABASE_USER`: the username of the PostgreSQL user to login as +- `DJANGO_DATABASE_PASSWORD`: the password of the PostgreSQL user to login as +- `DJANGO_LANGUAGE_CODE`: the language to use in the dynamic pages +- `DJANGO_TIME_ZONE`: the timezone to use in the display of datetimes + +## Development + +To run the project in development mode, run: + +```bash +./manage.py runserver 127.0.0.1:30033 +``` + +## Deployment + +This project is not currently ready for production usage. \ No newline at end of file