Add more descriptions for setup

This commit is contained in:
Stefan Wehrmeyer 2023-02-03 17:13:59 +01:00
parent 28cdd7c3c4
commit 80e56c1702
2 changed files with 16 additions and 1 deletions

View file

@ -8,12 +8,18 @@ A Django app that allows tracking government plans. Deployed at: https://fragden
Requires [GDAL/Geos for GeoDjango](https://docs.djangoproject.com/en/4.1/ref/contrib/gis/install/geolibs/). Requires [GDAL/Geos for GeoDjango](https://docs.djangoproject.com/en/4.1/ref/contrib/gis/install/geolibs/).
```bash ```bash
# Start a Postgres server with Postgis
docker compose up -d
# Setup virtualenv
python3 -m venv .venv python3 -m venv .venv
source .venv/bin/activate source .venv/bin/activate
# Install dependencies
pip install -e . pip install -e .
# Setup initial database
./manage.py migrate ./manage.py migrate
# Create admin user # Create admin user
./manage.py createsuperuser ./manage.py createsuperuser
# Start development server
./manage.py runserver ./manage.py runserver
``` ```
@ -24,3 +30,9 @@ pip install -e .
4. Publish that page 4. Publish that page
5. Setup a government and plans via the admin. 5. Setup a government and plans via the admin.
## Possible next steps
- Use the `project` directory as a blueprint for an app that uses this repo as a depdency.
- Setup [djangocms-text-ckeditor](https://github.com/django-cms/djangocms-text-ckeditor), [djangocms-frontend](https://github.com/django-cms/djangocms-frontend) and other CMS components/
- Use Django apps for social authentication.
- Override templates in your custom project.

View file

@ -96,6 +96,7 @@ TEMPLATES = [
"django.contrib.messages.context_processors.messages", "django.contrib.messages.context_processors.messages",
"sekizai.context_processors.sekizai", "sekizai.context_processors.sekizai",
"cms.context_processors.cms_settings", "cms.context_processors.cms_settings",
"froide.helper.context_processors.site_settings",
], ],
}, },
}, },
@ -169,7 +170,7 @@ DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
TAGGIT_CASE_INSENSITIVE = True TAGGIT_CASE_INSENSITIVE = True
TAGGIT_STRIP_UNICODE_WHEN_SLUGIFYING = True TAGGIT_STRIP_UNICODE_WHEN_SLUGIFYING = True
LOGIN_URL = "account-login" LOGIN_URL = "admin:login"
X_FRAME_OPTIONS = "SAMEORIGIN" X_FRAME_OPTIONS = "SAMEORIGIN"
# Django CMS # Django CMS
@ -183,6 +184,8 @@ CMS_TEMPLATES = [
SITE_ID = 1 SITE_ID = 1
SITE_NAME = "GovPlan" SITE_NAME = "GovPlan"
SITE_URL = "http://localhost:8000" SITE_URL = "http://localhost:8000"
SITE_EMAIL = "info@example.com"
SITE_LOGO = ""
FROIDE_CONFIG = { FROIDE_CONFIG = {
"bounce_enabled": False, "bounce_enabled": False,