From d601ad21efdbb5baacdea6bf5b964fd19612f7e8 Mon Sep 17 00:00:00 2001 From: Christophe Siraut Date: Thu, 28 Sep 2023 13:34:41 +0200 Subject: [PATCH] documentation: add a development setup section --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index a07ca2a..d24eb7e 100755 --- a/README.md +++ b/README.md @@ -15,6 +15,30 @@ This project is distributed under GPL version 3. More information in the LICENSE * **cms**: content management system. +## Development setup +Start installing a virtual environment : + +``` +virtualenv venv +source venv/bin/activate +pip install -r requirements.txt +pip install -r requirements_tests.txt +``` + +Then copy the default settings and initiate the database : + +``` +cp instance/settings/sample.py instance/settings/settings.py +DJANGO_SETTINGS_MODULE=instance.settings.dev ./manage.py migrate +``` + +Finally test and run the instance using development settings, and point your browser to http://localhost:8000 : + +``` +DJANGO_SETTINGS_MODULE=instance.settings.dev pytest +DJANGO_SETTINGS_MODULE=instance.settings.dev ./manage.py runserver +``` + ## Scripts Are included various configuration scripts that can be used to ease setup. They assume that the project is present in `/srv/apps/aircox`: