added basic logging and updated environment variables

Author: daniel-gray-tangent

.env.example

@@ -0,0 +1,10 @@
+SECRET_KEY='django-insecure-w!h85bp^$$e8gm%c23r!0%9i7yzd=6w$$s&ic+6!%306&kj8@k*5'
+DEBUG=True
+DB_HOST=db
+DB_PORT=5432
+DB_NAME=term_db
+DB_USER=sadilar
+DB_PASSWORD=sadilar
+LOGGING_FILE=logs/debug.log
+LOGGING_HANDLERS_LEVEL=INFO
+LOGGING_LOGGERS_LEVEL=INFO

README.md

@@ -24,8 +24,25 @@ About the project:
 3. Run `make run` to run the docker container
 4. Run `make stop` to stop the docker container
 
+## Production  
+
 
 ### Plugins installed
 #### Django Simple History
 
 https://django-simple-history.readthedocs.io/en/latest/
+
+#### Basic setup for production
+
+### environment variables
+
+please use .env.example as example
+
+## Suggested  folder structure
+
+Add the following folders to the Docker container:
+
+* /documents
+* /static_files
+* /logos
+* /media

app/app/settings.py

@@ -154,3 +154,52 @@
 # https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+
+if DEBUG:
+    LOGGING = {
+        "version": 1,
+        "disable_existing_loggers": False,
+        "handlers": {
+            "console": {
+                "class": "logging.StreamHandler",
+            },
+        },
+        "root": {
+            "handlers": ["console"],
+            "level": "DEBUG",
+        },
+    }
+else:
+    LOGGING = {
+        "version": 1,
+        "disable_existing_loggers": False,
+        "handlers": {
+            "console": {
+                "class": "logging.StreamHandler",
+            },
+            "file": {
+                "level": os.environ.get("LOGGING_HANDLERS_LEVEL", "WARNING"),
+                "class": "logging.FileHandler",
+                "filename": os.environ.get("LOGGING_FILE", "WARNING"),
+                "formatter": "verbose",
+            },
+        },
+        "root": {
+            "handlers": ["console", "file"],
+            "level": os.environ.get("LOGGING_LOGGERS_LEVEL", "WARNING"),
+        },
+        "loggers": {
+            "django": {
+                "handlers": ["file"],
+                "level": os.environ.get("LOGGING_LOGGERS_CONSOLE_LEVEL", "WARNING"),
+                "propagate": True,
+            },
+        },
+        "formatters": {
+            "verbose": {
+                "format": "{asctime} {levelname}  - {name} {module}.py (line: {lineno:d}). - {message}",
+                "style": "{",
+            },
+        },
+    }

docker-compose.yml

@@ -36,3 +36,7 @@ services:
       - DB_NAME=term_db  # see POSTGRES_DB above
       - DB_USER=sadilar  # see POSTGRES_USER above
       - DB_PASSWORD=sadilar  # see POSTGRES_PASSWORD above
+      - LOGGING_FILE=logs/debug.log
+      - LOGGING_HANDLERS_LEVEL=WARNING
+      - LOGGING_LOGGERS_LEVEL=WARNING
+      - LOGGING_LOGGERS_CONSOLE_LEVEL=WARNING