first pass

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,10 +25,11 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **System details:**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Python version [e.g. 3.12]
- - Software Versions [release/branch/commit]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Python version [e.g. 3.12]
+- Software Versions [release/branch/commit]
 
 **Additional context**
 Add any other context about the problem here.

pyproject.toml

@@ -6,7 +6,7 @@ authors = [
     { name = "Adrian D'Alessandro", email = "a.dalessandro@imperial.ac.uk" },
 ]
 requires-python = ">=3.12"
-dependencies = ["django"]
+dependencies = ["django", "whitenoise"]
 
 [project.optional-dependencies]
 dev = [

rse_competencies_toolkit/settings/__init__.py

@@ -0,0 +1,3 @@
+"""Django settings for rse_competencies_toolkit project."""
+
+from .settings import *  # noqa: F403

rse_competencies_toolkit/settings/_production.py

@@ -0,0 +1,19 @@
+"""Settings for app deployment in production.
+
+This module contains those settings that are not expected to vary between
+deployments. This module is not intended to be used directly but imported into another
+module where deployment specific settings are set.
+ADMINS and ALLOWED_HOSTS need to be defined in the deployment specific settings module.
+"""
+
+import os
+
+from .settings import *  # noqa: F403
+
+DEBUG = False
+SECRET_KEY = os.environ["SECRET_KEY"]
+SECURE_BROWSER_XSS_FILTER = True
+SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
+SECURE_HSTS_SECONDS = 15552000
+USE_X_FORWARDED_HOST = True
+EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"

rse_competencies_toolkit/settings.py → rse_competencies_toolkit/settings/settings.py

@@ -12,7 +12,7 @@
 from pathlib import Path
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
-BASE_DIR = Path(__file__).resolve().parent.parent
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
 
 
 # Quick-start development settings - unsuitable for production
@@ -75,7 +75,7 @@
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": BASE_DIR / "db.sqlite3",
+        "NAME": BASE_DIR / "db" / "db.sqlite3",
     }
 }
 
@@ -120,3 +120,11 @@
 # https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+
+# Custom settings
+INSTALLED_APPS += ["main"]
+
+
+MIDDLEWARE.insert(1, "whitenoise.middleware.WhiteNoiseMiddleware")
+STATIC_ROOT = BASE_DIR / "staticfiles"