Merge pull request 'Update .env.template' (#18) from woutervermeer-patch-1 into main

Reviewed-on: #18

.docker-compose-files/compose.check.yaml

@@ -0,0 +1,14 @@
+services:
+  web:
+    command: python manage.py check --deploy
+    restart: "no"
+    env_file:
+      - path: .env.template
+        required: true
+
+
+  db:
+    env_file:
+      - path: .env.template
+        required: true
+

.docker-compose-files/compose.dev.yaml

@@ -0,0 +1,18 @@
+services:
+  web:
+    command: gunicorn --capture-output --enable-stdio-inheritance -b 0.0.0.0:8000 website.wsgi:application
+    volumes:
+      - ./src:/src
+    env_file:
+      - path: .env.template
+        required: true
+      - path: .env
+        required: false
+
+  db:
+    env_file:
+      - path: .env.template
+        required: true
+      - path: .env
+        required: false
+

.docker-compose-files/compose.prod.yaml

@@ -0,0 +1,10 @@
+services:
+  web:
+    env_file:
+      - path: .env
+        required: true
+
+  db:
+    env_file:
+      - path: .env
+        required: true

.docker-compose-files/compose.test.yaml

@@ -0,0 +1,14 @@
+services:
+  web:
+    command: python manage.py check --deploy; python -Wa manage.py test --noinput --parallel
+    restart: "no"
+    env_file:
+      - path: .env.template
+        required: true
+
+
+  db:
+    env_file:
+      - path: .env.template
+        required: true
+

.env.template

@@ -0,0 +1,20 @@
+#NGINX
+NGINX_HOSTNAME=localhost
+
+# Django
+DJANGO_SETTINGS_MODULE=website.settings
+DJANGO_SECRET_KEY=CWHZCAZBNV57tDkwGHJwTUu3PCSnGG45
+DEBUG=TRUE
+#ALLOWED_HOSTS=localhost
+
+# Database (PostgreSQL)
+POSTGRES_USER=test_user
+POSTGRES_PASSWORD=test_password
+POSTGRES_HOST=db
+POSTGRES_PORT=5432
+POSTGRES_DBNAME=test_dbname # == POSTGRES_DB
+POSTGRES_DB=test_db
+
+# Gunicorn
+GUNICORN_WORKERS=3
+GUNICORN_TIMEOUT=120

.gitea/workflows/build_test.yaml

@@ -0,0 +1,20 @@
+name: Gitea build & Test.
+run-name: ${{ gitea.actor }}
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build and test
+        run: make test
+
+      - name: Build
+        run: make prod

.gitea/workflows/deploy.yml

@@ -0,0 +1,38 @@
+name: Deploy to production
+run-name: deploy-${{ gitea.actor }}
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup SSH
+        run: |
+          mkdir -p ~/.ssh
+          echo "${{ secrets.SSH_KEY }}" > ~/.ssh/id_rsa
+          chmod 600 ~/.ssh/id_rsa
+          ssh-keyscan -H ${{ secrets.DEPLOY_HOST }} >> ~/.ssh/known_hosts
+
+      - name: Deploy
+        run: |
+          ssh -i ~/.ssh/id_rsa ${{ secrets.DEPLOY_USER }}@${{ secrets.DEPLOY_HOST }} << 'EOF'
+            cd ~/Quatsh-Website
+
+            echo "Pulling latest code..."
+            git pull origin main
+
+            echo "Building containers..."
+            make prod
+
+            echo "Running Django deploy check"
+            docker compose run --rm web python manage.py check --deploy
+
+            echo "Deployment complete."
+          EOF

.gitea/workflows/test.yaml

@@ -0,0 +1,17 @@
+name: Gitea Test.
+run-name: ${{ gitea.actor }}
+on:
+  push:
+    branches:
+      - pre-prod
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: test
+        run: make test

.gitignore

@@ -136,6 +136,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+!.env.template
 
 # Spyder project settings
 .spyderproject
@@ -174,3 +175,7 @@ cython_debug/
 # PyPI configuration file
 .pypirc
 
+# gunicon webserver
+gunicorn.ctl
+
+

.nginx/.conf

@@ -0,0 +1,3 @@
+events {}
+
+http {}

.nginx/.templates/nginx.conf.template

@@ -0,0 +1,49 @@
+server {
+  listen ${NGINX_PORT};
+  server_name ${NGINX_HOSTNAME};
+
+  location /static/ {
+    alias /app/static/;
+    expires 30d;
+    add_header Cache-Control "public";
+  }
+
+  location /media/ {
+    alias /app/media;
+    expires 30d;
+    add_header Cache-Control "public";
+  }
+
+  location / {
+    proxy_pass http://web:8000;
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+  }
+}
+
+server {
+  listen ${NGINX_SSL_PORT};
+  server_name ${NGINX_HOSTNAME};
+
+  location /static/ {
+    alias /app/static/;
+    expires 30d;
+    add_header Cache-Control "public";
+  }
+
+  location /media/ {
+    alias /app/media;
+    expires 30d;
+    add_header Cache-Control "public";
+  }
+
+  location / {
+    proxy_pass http://web:8000;
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+  }
+}

Dockerfile

@@ -1,16 +1,13 @@
 FROM python:3.14-alpine
 
-RUN mkdir /app
+WORKDIR /src
 
-WORKDIR /app
+COPY requirements.txt /src/
+COPY gunicorn.conf.py /src/
+COPY ./src/ /src/
 
-RUN pip install --upgrade pip
-
-COPY requirements.txt /app/
-COPY gunicorn.conf.py /app/
-COPY ./app/ /app/
-
-RUN pip install --no-cache-dir -r requirements.txt
+RUN pip install --upgrade pip && \
+  pip install --no-cache-dir -r requirements.txt
 
 EXPOSE 8000
 

Makefile

@@ -0,0 +1,26 @@
+prod:
+	docker compose down
+	docker compose --env-file .env -f ./compose.yaml -f ./.docker-compose-files/compose.prod.yaml up -d --build 
+	docker exec quatsh-website-web-1 python manage.py collectstatic --noinput
+	docker exec quatsh-website-web-1 python manage.py check --deploy
+	docker exec quatsh-website-web-1 python manage.py migrate
+
+dev:
+	docker compose down
+	docker compose -f ./compose.yaml -f ./.docker-compose-files/compose.dev.yaml up --build -d
+	docker exec quatsh-website-web-1 python manage.py collectstatic --noinput
+	docker exec -it quatsh-website-web-1 sh
+
+dev_restart:
+	docker compose down
+	docker compose -f ./compose.yaml -f ./.docker-compose-files/compose.dev.yaml up -d
+	docker exec -it quatsh-website-web-1 sh
+
+dev_restart_with_logs:
+	docker compose down
+	docker compose -f ./compose.yaml -f ./.docker-compose-files/compose.dev.yaml up
+	
+
+test:
+	docker compose --env-file .env.template -f ./compose.yaml -f ./.docker-compose-files/compose.test.yaml up --build --abort-on-container-exit --exit-code-from web
+

README.md

@@ -1,2 +1,65 @@
 # Quatsh-Website
 
+## Requirements
+
+### Install make
+
+Running this requires the use of "make" and docker.
+
+"make" tends to come pre-installed on linux but not on Windows, to install it on Windows I recommend using Chocolatey as follows: \
+
+```
+choco install make
+```
+
+### Install docker
+
+<https://docs.docker.com/get-started/get-docker/>
+
+## Running for the first time
+
+### Env
+
+Before running the container environment has to be setup first, so first run:
+
+```
+cp .env.template .env
+```
+
+Then make any changes to the .env file.
+
+### Running the website
+
+To run the website 3 options have been provided
+
+#### Development
+
+For development purposes only as the src folder has been mounted in the container to allow for the making of changes without rebuilding the entire image.
+Properly utilising this also requires the DEBUG environment variable to be set to TRUE.
+
+```shell
+make dev
+```
+
+#### Testing
+
+Runs the testing environment and exits.
+
+```shell
+make test
+```
+
+#### Production
+
+Using `make prod` is identical but preferred here.
+
+```shell
+make prod
+```
+
+Or
+
+```shell
+make
+```
+

app/website/settings.py

@@ -1,117 +0,0 @@
-"""
-Django settings for website project.
-
-Generated by 'django-admin startproject' using Django 6.0.3.
-
-For more information on this file, see
-https://docs.djangoproject.com/en/6.0/topics/settings/
-
-For the full list of settings and their values, see
-https://docs.djangoproject.com/en/6.0/ref/settings/
-"""
-
-from pathlib import Path
-
-# Build paths inside the project like this: BASE_DIR / 'subdir'.
-BASE_DIR = Path(__file__).resolve().parent.parent
-
-
-# Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/6.0/howto/deployment/checklist/
-
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'django-insecure-c$q7wdq+u@ow74wp!&zzkxdylkueu)(+34e%!e0du&bjwoqz9z'
-
-# SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
-
-ALLOWED_HOSTS = []
-
-
-# Application definition
-
-INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
-]
-
-MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
-]
-
-ROOT_URLCONF = 'website.urls'
-
-TEMPLATES = [
-    {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.request',
-                'django.contrib.auth.context_processors.auth',
-                'django.contrib.messages.context_processors.messages',
-            ],
-        },
-    },
-]
-
-WSGI_APPLICATION = 'website.wsgi.application'
-
-
-# Database
-# https://docs.djangoproject.com/en/6.0/ref/settings/#databases
-
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': BASE_DIR / 'db.sqlite3',
-    }
-}
-
-
-# Password validation
-# https://docs.djangoproject.com/en/6.0/ref/settings/#auth-password-validators
-
-AUTH_PASSWORD_VALIDATORS = [
-    {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
-    },
-    {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
-    },
-    {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
-    },
-    {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
-    },
-]
-
-
-# Internationalization
-# https://docs.djangoproject.com/en/6.0/topics/i18n/
-
-LANGUAGE_CODE = 'en-us'
-
-TIME_ZONE = 'UTC'
-
-USE_I18N = True
-
-USE_TZ = True
-
-
-# Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/6.0/howto/static-files/
-
-STATIC_URL = 'static/'

compose.yaml

@@ -1,9 +1,67 @@
 services:
   web:
     build: .
-    ports:
-      - 8000:8000
+    command: gunicorn website.wsgi:application
+    depends_on:
+      - db
     environment:
-      - PYTHONDONTWRITEBYTECODE=1
-      - PYTHONUNBUFFERED=1
+      ALLOWED_HOSTS: ${NGINX_HOSTNAME}
+      PYTHONDONTWRITEBYTECODE: 1
+      PYTHONUNBUFFERED: 1
+      DJANGO_SETTINGS_MODULE: ${DJANGO_SETTINGS_MODULE}
+      VIRTUAL_HOST: localhost
+      #VIRTUAL_PORT: 8000
     restart: unless-stopped
+    volumes:
+      - static_volume:/app/static
+      - media_volume:/app/media
+
+
+  db:
+    image: postgres:18
+    environment:
+      POSTGRES_DB: ${POSTGRES_DBNAME}
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+    volumes:
+      - postgres_data:/var/lib/postgresql
+    restart: unless-stopped
+
+  adminer:
+    image: adminer
+    depends_on:
+      - db
+    restart: always
+    ports:
+      - 8080:8080
+
+  proxy:
+    image: nginx:stable
+    volumes:
+      - ./.nginx/.templates:/etc/nginx/templates
+      - static_volume:/app/static:ro
+      - media_volume:/app/media:ro
+    restart: unless-stopped
+    ports:
+      - 80:80
+      - 443:443
+    environment:
+      - NGINX_HOSTNAME=${NGINX_HOSTNAME}
+      - NGINX_PORT=80
+      - NGINX_SSL_PORT=443
+    depends_on:
+      - web
+
+  test:
+    build: .
+    command: python manage.py test
+    depends_on:
+      - db
+    profiles:
+      - test
+
+
+volumes:
+  postgres_data:
+  static_volume:
+  media_volume:

docker-compose.dev.yml

@@ -1,5 +0,0 @@
-services:
-  web:
-    volumes:
-      - ./app:/app
-

requirements.txt

@@ -1,2 +1,5 @@
 Django==6.0.3
 gunicorn==25.1.0
+psycopg [binary] ==3.3.3
+django-browser-reload
+django-watchfiles

src/polls/admin.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+
+# Register your models here.
+
+from .models import Question
+
+admin.site.register(Question)

src/polls/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class PollsConfig(AppConfig):
+    name = 'polls'

src/polls/migrations/0001_initial.py

@@ -0,0 +1,32 @@
+# Generated by Django 6.0.3 on 2026-03-25 14:26
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Question',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('question_text', models.CharField(max_length=200)),
+                ('pub_date', models.DateTimeField(verbose_name='date published')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Choice',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('choice_text', models.CharField(max_length=200)),
+                ('votes', models.IntegerField(default=0)),
+                ('question', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='polls.question')),
+            ],
+        ),
+    ]

src/polls/models.py

@@ -0,0 +1,20 @@
+from django.db import models
+
+# Create your models here.
+
+
+class Question(models.Model):
+    question_text = models.CharField(max_length=200)
+    pub_date = models.DateTimeField("date published")
+
+    def __str__(self):
+        return self.question_text
+
+
+class Choice(models.Model):
+    question = models.ForeignKey(Question, on_delete=models.CASCADE)
+    choice_text = models.CharField(max_length=200)
+    votes = models.IntegerField(default=0)
+
+    def __str__(self):
+        return self.choice_text

src/polls/templates/polls/detail.html

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8" />
+    <title>My test page</title>
+  </head>
+  <body>
+    <h1>Hey This is a test of watchfiles + browser reload!</h1>
+    {{ question }}
+  </body>
+</html>

src/polls/templates/polls/index.html

@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8" />
+    <title>My test page</title>
+  </head>
+  <body>
+    {% if latest_question_list %}
+        <ul>
+        {% for question in latest_question_list %}
+        <li><a href="{% url 'polls:detail' question.id %}">{{ question.question_text }}</a></li>
+        {% endfor %}
+        </ul>
+    {% else %}
+        <p>No polls are available.</p>
+    {% endif %}
+  </body>
+</html>
+

src/polls/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

src/polls/urls.py

@@ -0,0 +1,14 @@
+from django.urls import path
+
+from . import views
+
+urlpatterns = [
+    # ex: /polls/
+    path("", views.index, name="index"),
+    # ex: /polls/5/
+    path("<int:question_id>/", views.detail, name="detail"),
+    # ex: /polls/5/results/
+    path("<int:question_id>/results/", views.results, name="results"),
+    # ex: /polls/5/vote/
+    path("<int:question_id>/vote/", views.vote, name="vote"),
+]

src/polls/views.py

@@ -0,0 +1,24 @@
+from django.http import HttpResponse, Http404
+from django.shortcuts import get_object_or_404, render
+
+from .models import Question
+
+
+def index(request):
+    latest_question_list = Question.objects.order_by("-pub_date")[:5]
+    context = {"latest_question_list": latest_question_list}
+    return render(request, "polls/index.html", context)
+
+
+def detail(request, question_id):
+    question = get_object_or_404(Question, pk=question_id)
+    return render(request, "polls/detail.html", {"question": question})
+
+
+def results(request, question_id):
+    response = "You're looking at the results of question %s."
+    return HttpResponse(response % question_id)
+
+
+def vote(request, question_id):
+    return HttpResponse("You're voting on question %s." % question_id)

src/website/settings.py

@@ -0,0 +1,128 @@
+"""
+Django settings for website project.
+
+Generated by 'django-admin startproject' using Django 6.0.3.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/6.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/6.0/ref/settings/
+"""
+
+from pathlib import Path
+import os
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/6.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = os.environ["DJANGO_SECRET_KEY"]
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = os.getenv("DEBUG") == "TRUE"
+
+ALLOWED_HOSTS = os.getenv("ALLOWED_HOSTS", "127.0.0.1").split(",")
+
+SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
+
+# Application definition
+
+INSTALLED_APPS = [
+    "polls.apps.PollsConfig",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "django_browser_reload",
+    "django_watchfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "django_browser_reload.middleware.BrowserReloadMiddleware",
+]
+
+ROOT_URLCONF = "website.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "website.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/6.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": os.getenv("POSTGRES_DBNAME"),
+        "USER": os.getenv("POSTGRES_USER"),
+        "PASSWORD": os.getenv("POSTGRES_PASSWORD"),
+        "HOST": os.getenv("POSTGRES_HOST"),
+        "PORT": os.getenv("POSTGRES_PORT"),
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/6.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/6.0/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "Europe/Amsterdam"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/6.0/howto/static-files/
+
+STATIC_ROOT = "/app/static/"
+STATIC_URL = "static/"

src/website/urls.py

@@ -14,9 +14,12 @@ Including another URLconf
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
 from django.contrib import admin
-from django.urls import path
+from django.urls import path, include
 
 urlpatterns = [
-    path('admin/', admin.site.urls),
+    path("__reload__/", include("django_browser_reload.urls")),
+    path("polls/", include("polls.urls")),
+    path("admin/", admin.site.urls),
 ]