From 5047e2f68b169e5efc3c406148a9a76c29ffc96d Mon Sep 17 00:00:00 2001 From: Ben Sturmfels Date: Thu, 26 Oct 2023 13:22:45 +1100 Subject: [PATCH] Extend docs for local development and production deploy --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9b8d5591..61aec362 100644 --- a/README.md +++ b/README.md @@ -33,15 +33,32 @@ exist** on disk for the redirect to be applied. ## Local development -Python dependencies are tied to the versions available in Debian. +Python dependencies in `requirements.txt` are tied to the versions available in +Debian: python3 -m pip install -r requirements.txt - cd www + +You'll need a copy of `conservancy/djangocommonsettings.py`, a file that not +committed to the repository that has database settings and other +environment-specific config. + +Then run: + + python manage.py migrate python manage.py runserver +There is also a Dockerfile available if that's more convenient. See that file +for details. + ## Deploying Changes pushed to the https://k.sfconservancy.org/website repository are automatically deployed to the production website by the `conservancy-www-update` SystemD timer. See `systemd/conservancy-www-update.timer` for details. + +The `migrate` and `collectstatic` commands are not run automatically. You may +need to run these if modifying the database schema or adding/moving static files: + + sudo -u www-data /var/www/venv-website/bin/python manage.py migrate + sudo -u www-data /var/www/venv-website/bin/python manage.py collectstatic --link