updated docs

Makefile

@@ -1,14 +1,14 @@
 .SHELLFLAGS := -ec
 
 prod:
-	docker compose down
+	docker compose --env-file .env -f ./compose.yaml -f ./.docker-compose-files/compose.prod.yaml down 
 	docker compose --env-file .env -f ./compose.yaml -f ./.docker-compose-files/compose.prod.yaml up -d --build 
 	docker compose exec web python manage.py collectstatic --noinput
 	docker compose exec web python manage.py check --deploy
 	docker compose exec web python manage.py migrate
 
 dev:
-	docker compose down
+	docker compose -f ./compose.yaml -f ./.docker-compose-files/compose.dev.yaml down
 	docker compose -f ./compose.yaml -f ./.docker-compose-files/compose.dev.yaml up --build -d
 	docker compose exec web python manage.py collectstatic --noinput
 	docker compose exec -it web sh

README.md

@@ -43,6 +43,8 @@ To run the website 3 options have been provided
 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.
 
+Setup to allow live-reloading without manual intervention after normal file changes (i.e. updates to css, html and python functions).
+
 ```shell
 make dev
 ```

docs/ROADMAP.md

@@ -2,23 +2,59 @@
 
 This document contains the wanted feature list and their current state.
 
-## Basic Pages
+## Basic Templates
+- [] Nav-bar ~ Adjust based on permission status
+- [] Low-bar ~ KVK etc.
+- [] Basic page layout
 
--[] Homepage
+## Pages
--[] Boards
--[] Committee page
--[] Contact page
--[] Donator page/Friends of Quatsh
--[] Membership page
 
-## Main Features
+### Must
 
--[] Signup form with email SMTP link.
+- [] Homepage
--[] Gallery
+- [] Signups 
--[] Login page
+- [] Contact
+- [] Contribution-Cost
+
+### Should
+- [] Login page
+- [] Gallery
+- [] Boards
+
+### Could
+- [] Committee page
+- [] Donator page/Friends of Quatsh
+
+## Features
+
+- [] Signup form with email SMTP link.
+- [] Gallery
+- [] Login page
+
+## Security 
+
+- [] SSL implementation
+- [] ACME SSL certificate
 
 ## Extra's
 
--[] Allow google-workspace login with SSO?
+- [] Allow google-workspace login with SSO?
--[] Add Redis for Caching
+- [] Add Redis for Caching
--[] Setup SMTP with automatic switching to in-mem email saving OR print to stdout when in DEBUG mode.
+- [] Add [Celery](https://docs.celeryq.dev/en/stable/index.html#) for async background-[task](https://docs.djangoproject.com/en/6.0/topics/tasks/) completion.
+- [] Setup SMTP with automatic switching to in-mem email saving OR print to stdout when in DEBUG mode.
+- [] Split-Storage setup for authenticated-only file access, such as private gallery pictures.
+
+## Priority List
+
+- [] General layout template
+- [] Nav-bar
+- [] Homepage
+- [] Lower-bar ~ KVK
+- [] Signups page
+- [] Calender (Google calender)
+- [] Gallery 
+- [] CCP page
+- [] Contact page
+- [] Boards
+- [] Committee page
+- [] Donator page/Friends of Quatsh

docs/installation_faq.md

@@ -20,3 +20,12 @@ After running this command a Django Migration has to be run to remake the tables
 ``` shell
 docker exec quatsh-website-web-1 python manage.py migrate
 ```
+
+## Make - errors
+
+If you see an error looking as follows docker isn't actually running.
+```
+PS C:\*\Quatsh-Website> docker compose ls
+error during connect: Get "http://%2F%2F.%2Fpipe%2FdockerDesktopLinuxEngine/v1.50/containers/json?filters=%7B%22label%22%3A%7B%22com.docker.compose.config-hash%22%3Atrue%2C%22com.docker.compose.project%22%3Atrue%7D%7D": open //./pipe/dockerDesktopLinuxEngine: The system cannot find the file specified.
+```
+

src/gallery/templates/gallery/index.html

@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+{% load static %}
+{% block title %}Home{% endblock %}
+{% block content %}<h1>Welcome</h1>{% endblock %}

src/gallery/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from . import views
+
+app_name = "gallery"
+
+urlpatterns = [
+    path("", views.index, name="index"),
+]

src/gallery/views.py

@@ -1,3 +1,5 @@
 from django.shortcuts import render
 
-# Create your views here.
+
+def index(request):
+    return render(request, "gallery/index.html")

src/polls/urls.py

@@ -2,6 +2,8 @@ from django.urls import path
 
 from . import views
 
+app_name = "polls"
+
 urlpatterns = [
     # ex: /polls/
     path("", views.index, name="index"),

src/templates/components/topbar.html

@@ -1,4 +1,8 @@
 <nav>
-    <a href="{% url 'core:index' %}">Home</a>
+	<ul>
+		<li><a href="{% url 'core:index' %}">Home</a></li>
+		<li><a href="{% url 'polls:index' %}">Polls</a></li>
+		<li><a href="{% url 'gallery:index' %}">Gallery</a></li>
+	</ul>
     <!-- rest of your topbar -->
 </nav>

src/website/settings.py

@@ -35,6 +35,7 @@ SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
 INSTALLED_APPS = [
     "polls.apps.PollsConfig",
     "core.apps.CoreConfig",
+    "gallery.apps.GalleryConfig",
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",

src/website/urls.py

@@ -23,6 +23,7 @@ from django.urls import include, path
 urlpatterns = [
     path("", include("core.urls")),
     path("polls/", include("polls.urls")),
+    path("gallery/", include("gallery.urls")),
     path("admin/doc/", include("django.contrib.admindocs.urls")),
     path("admin/", admin.site.urls),
 ]