rc/aircox
13
1
Fork 1
Code Issues 15 Pull Requests Projects Releases Wiki Activity

documentation: add a development setup section

Browse Source
This commit is contained in:
Chris Tactic 2023-09-28 13:34:41 +02:00
parent d59f3402cd
commit 1ced37c330
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -15,6 +15,31 @@ This project is distributed under GPL version 3. More information in the LICENSE
* **cms**: content management system. * **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
python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())" >> 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 ## Scripts
Are included various configuration scripts that can be used to ease setup. They Are included various configuration scripts that can be used to ease setup. They
assume that the project is present in `/srv/apps/aircox`: assume that the project is present in `/srv/apps/aircox`: