Add PostgreSQL DB support

Author: tudoramariei

.env.example

@@ -38,21 +38,21 @@ RUN_CREATE_SUPER_USER=True
 RUN_CREATE_ADMIN=True
 
 # database
-# change DATABASE_ENGINE to "mysql" if you want to use MySQL
-DATABASE_ENGINE=sqlite3
-# these are only used if DATABASE_ENGINE is mysql
+# change DATABASE_ENGINE to "mysql" if you want to use MySQL or "psql" for PostgreSQL
+DATABASE_ENGINE=psql
+# these are only used if DATABASE_ENGINE is mysql or psql
 DATABASE_NAME=redirect
 DATABASE_USER=user
 DATABASE_PASSWORD=password
 DATABASE_HOST=db
-DATABASE_PORT=3306
+DATABASE_PORT=5432
 
 # Email addresses
 DEFAULT_FROM_EMAIL=[email protected]
 NO_REPLY_EMAIL=[email protected]
 
 # Email server
-EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
+EMAIL_BACKEND=django.core.mail.backends.console.EmailBackend
 EMAIL_HOST=
 EMAIL_HOST_USER=
 EMAIL_HOST_PASSWORD=

Makefile

@@ -19,6 +19,12 @@ stop-mysql:                       ## stops the mysql dev project
 drop-mysql:                       ## stops the mysql dev project
 	docker compose --profile mysql down -v -t 60
 
+stop-psql:                       ## stops the psql dev project
+	docker compose --profile psql down -t 60
+
+drop-psql:                       ## stops the psql dev project
+	docker compose --profile psql down -v -t 60
+
 stop-prod:                        ## stops the mysql dev project
 	docker compose -f docker-compose.prod.yml down -t 60
 
@@ -38,39 +44,45 @@ up-mysql:                         ## run the project with mysql
 upd-mysql:                        ## run the project with mysql in detached mode
 	docker compose --profile mysql up -d --build
 
+up-psql:                         ## run the project with psql
+	docker compose --profile psql up --build
+
+upd-psql:                        ## run the project with psql in detached mode
+	docker compose --profile psql up -d --build
+
 up-prod:                         ## run the project with mysql
 	docker compose -f docker-compose.prod.yml up --build
 
 upd-prod:                        ## run the project with mysql in detached mode
 	docker compose -f docker-compose.prod.yml up -d --build
 
 ### Using the SQLite database
-run-sqlite: stop-mysql up-sqlite      ## run the project with sqlite and stop the mysql project beforehand
-rund-sqlite: stop-mysql upd-sqlite    ## run the project with sqlite in detached mode and stop the mysql project beforehand
-redo-sqlite: drop-sqlite up-sqlite    ## delete the db and rerun the project with sqlite
-redod-sqlite: drop-sqlite upd-sqlite  ## delete the db and rerun the project with sqlite in detached mode
+run-sqlite: stop-psql stop-mysql up-sqlite   ## run the project with sqlite and stop the mysql project beforehand
+rund-sqlite: stop-psql stop-mysql upd-sqlite ## run the project with sqlite in detached mode and stop the mysql project beforehand
+redo-sqlite: drop-sqlite up-sqlite           ## delete the db and rerun the project with sqlite
+redod-sqlite: drop-sqlite upd-sqlite         ## delete the db and rerun the project with sqlite in detached mode
 
 ### Using the MySQL database
-run-mysql: stop-sqlite up-mysql    ## run the project with mysql and stop the sqlite project beforehand
-rund-mysql: stop-sqlite upd-mysql  ## run the project with mysql in detached mode and stop the sqlite project beforehand
-redo-mysql: drop-mysql up-mysql    ## delete the db and rerun the project with mysql
-redod-mysql: drop-mysql upd-mysql  ## delete the db and rerun the project with mysql in detached mode
+run-mysql: stop-psql stop-sqlite up-mysql    ## run the project with mysql and stop the sqlite project beforehand
+rund-mysql: stop-psql stop-sqlite upd-mysql  ## run the project with mysql in detached mode and stop the sqlite project beforehand
+redo-mysql: drop-mysql up-mysql              ## delete the db and rerun the project with mysql
+redod-mysql: drop-mysql upd-mysql            ## delete the db and rerun the project with mysql in detached mode
 
-### With an image built for production
-run-prod: up-prod                 ## run the project with production settings
-rund-prod: upd-prod               ## run the project with production settings in detached mode
-redo-prod: drop-prod up-prod      ## delete the db and rerun the project with mysql
-redod-prod: drop-prod upd-prod    ## delete the db and rerun the project with mysql in detached mode
+### Using the PostgreSQL database
+run-psql: stop-mysql stop-sqlite up-psql      ## run the project with psql and stop the mysql project beforehand
+rund-psql: stop-mysql stop-sqlite upd-psql    ## run the project with psql in detached mode and stop the mysql project beforehand
+redo-psql: drop-psql up-psql                  ## delete the db and rerun the project with psql
+redod-psql: drop-psql upd-psql                ## delete the db and rerun the project with psql in detached mode
 
 ### Other run options
 run: run-sqlite                   ## set the default run command to sqlite
 redo: redo-sqlite                 ## set the default redo command to sqlite
 rund: rund-sqlite                 ## set the default run command to sqlite
 redod: redod-sqlite               ## set the default redo command to sqlite
 
-stop: stop-sqlite stop-mysql stop-prod ## stop all running projects
+stop: stop-sqlite stop-mysql stop-psql stop-prod ## stop all running projects
 
-drop: drop-sqlite drop-mysql drop-prod ## drop all databases
+drop: drop-sqlite drop-mysql drop-psql drop-prod ## drop all databases
 
 
 ## [Monitoring the containers]
@@ -137,6 +149,7 @@ requirements-update:              ## run pip compile and rebuild the requirement
 ## [Clean-up]
 clean-docker:                     ## stop docker containers and remove orphaned images and volumes
 	docker compose --profile mysql down -t 60
+	docker compose --profile psql down -t 60
 	docker compose --profile sqlite3 down -t 60
 	docker compose -f docker-compose.prod.yml down -t 60
 	docker system prune -f

backend/donations/views/ngo.py

@@ -61,7 +61,7 @@ class FormSignature(BaseHandler):
     template_name = "signature.html"
 
     def __init__(self, **kwargs):
-        super().__init__(kwargs)
+        super().__init__(**kwargs)
         self.ngo = None
         self.donor = None
 

backend/redirectioneaza/settings.py

@@ -227,23 +227,28 @@
 
 # Database
 # https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+DATABASE_ENGINE = env("DATABASE_ENGINE")
 
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": os.path.abspath(os.path.join(BASE_DIR, ".db_sqlite", "db.sqlite3")),
-    }
+REMOTE_DATABASE_ENGINES = {
+    "mysql": "django.db.backends.mysql",
+    "psql": "django.db.backends.postgresql",
 }
-
-if env.str("DATABASE_ENGINE") == "mysql":
+if DATABASE_ENGINE in REMOTE_DATABASE_ENGINES.keys():
+    DATABASES = {
+        "default": {
+            "ENGINE": REMOTE_DATABASE_ENGINES[DATABASE_ENGINE],
+            "NAME": env("DATABASE_NAME"),
+            "USER": env("DATABASE_USER"),
+            "PASSWORD": env("DATABASE_PASSWORD"),
+            "HOST": env("DATABASE_HOST"),
+            "PORT": env("DATABASE_PORT"),
+        }
+    }
+else:
     DATABASES = {
         "default": {
-            "ENGINE": "django.db.backends.mysql",
-            "NAME": env.str("DATABASE_NAME"),
-            "USER": env.str("DATABASE_USER"),
-            "PASSWORD": env.str("DATABASE_PASSWORD"),
-            "HOST": env.str("DATABASE_HOST"),
-            "PORT": env.str("DATABASE_PORT"),
+            "ENGINE": "django.db.backends.sqlite3",
+            "NAME": os.path.abspath(os.path.join(BASE_DIR, ".db_sqlite", "db.sqlite3")),
         }
     }
 
@@ -421,6 +426,7 @@
 LIST_OF_COUNTIES = [county[1] for county in COUNTIES_CHOICES]
 FORM_COUNTIES = deepcopy(LIST_OF_COUNTIES)
 FORM_COUNTIES.pop(LIST_OF_COUNTIES.index("București"))
+FORM_COUNTIES.insert(0, "Național")
 CONTACT_EMAIL_ADDRESS = env.str("CONTACT_EMAIL_ADDRESS")
 
 # Django Q2

backend/requirements-dev.txt

@@ -121,6 +121,8 @@ platformdirs==4.1.0
     # via black
 psutil==5.9.8
     # via -r requirements.txt
+psycopg2-binary==2.9.9
+    # via -r requirements.txt
 pycparser==2.21
     # via
     #   -r requirements.txt

backend/requirements.in

@@ -4,15 +4,18 @@ django-environ~=0.11.2
 # captcha
 django-recaptcha==4.0.0
 
+# encrypting data
+cryptography==42.0.2
+
 # django-q
 django-q2~=1.6.1
 blessed~=1.20.0  # optional requirement for django-q2
 psutil~=5.9.8  # optional requirement for django-q2
 croniter~=2.0.1  # optional requirement for django-q2
 
-# MySQL database
+# database
 pymysql~=1.1.0
-cryptography==42.0.2
+psycopg2-binary~=2.9.9
 
 # Sentry
 sentry-sdk[django]==1.40.0

backend/requirements.txt

@@ -77,6 +77,8 @@ pillow==10.2.0
     # via reportlab
 psutil==5.9.8
     # via -r requirements.in
+psycopg2-binary==2.9.9
+    # via -r requirements.in
 pycparser==2.21
     # via cffi
 pymysql==1.1.0

dkcp.base.yml

@@ -18,7 +18,7 @@ services:
       - "PYTHONUNBUFFERED=1"
     restart: on-failure
 
-  db_base:
+  db_base_mysql:
     image: mysql:8.2.0
     restart: always
     env_file:
@@ -32,3 +32,17 @@ services:
       MYSQL_ROOT_PASSWORD: "${DATABASE_PASSWORD}"
     ports:
       - "${DATABASE_PORT:-3306}:3306"
+
+  db_base_psql:
+    image: postgres:16.1
+    restart: always
+    env_file:
+      - .env
+    volumes:
+      - redirect_psql:/var/lib/postgresql/data
+    environment:
+      POSTGRES_DB: "${DATABASE_NAME}"
+      POSTGRES_USER: "${DATABASE_USER}"
+      POSTGRES_PASSWORD: "${DATABASE_PASSWORD}"
+    ports:
+      - "${DATABASE_PORT:-5432}:5432"

docker-compose.prod.yml

@@ -15,6 +15,7 @@ services:
       - ./backend/media:/var/www/redirect/backend/media
     environment:
       - "ENVIRONMENT=production"
+      - "DATABASE_ENGINE=psql"
     ports:
       - "${WEBAPP_PORT:-8080}:80"
     depends_on:
@@ -35,7 +36,8 @@ services:
   db:
     extends:
       file: dkcp.base.yml
-      service: db_base
+      service: db_base_psql
+    container_name: redirect_psql
 
 volumes:
-  redirect_mysql:
+  redirect_psql:

docker-compose.yml

@@ -20,8 +20,22 @@ services:
     container_name: redirect_dev
     environment:
       - "DATABASE_ENGINE=mysql"
+      - "DATABASE_HOST=redirect_mysql"
+      - "DATABASE_PORT=3306"
     depends_on:
-      - db
+      - db_mysql_dev
+
+  webapp_psql:
+    profiles: [ "psql" ]
+    extends:
+      service: redirect_dev_base
+    container_name: redirect_dev
+    environment:
+      - "DATABASE_ENGINE=psql"
+      - "DATABASE_HOST=redirect_psql"
+      - "DATABASE_PORT=5432"
+    depends_on:
+      - db_psql_dev
 
   redirect_dev_base:
     profiles: [ "_base" ]
@@ -36,6 +50,8 @@ services:
       - ./backend:/var/www/redirect/backend
     environment:
       - "ENVIRONMENT=development"
+    env_file:
+      - .env
     ports:
       - "${WEBAPP_PORT:-8080}:8000"
 
@@ -55,14 +71,24 @@ services:
     ports:
       - "${API_PORT:-8123}:80"
 
-  db:
+  db_mysql_dev:
     profiles: [ "mysql" ]
     extends:
       file: dkcp.base.yml
-      service: db_base
-    container_name: redirect_mysql_dev
+      service: db_base_mysql
+    container_name: redirect_mysql
     volumes:
       - ./docker/init-mysql:/docker-entrypoint-initdb.d
 
+  db_psql_dev:
+    profiles: [ "psql" ]
+    extends:
+      file: dkcp.base.yml
+      service: db_base_psql
+    container_name: redirect_psql
+    volumes:
+      - ./docker/init-psql:/docker-entrypoint-initdb.d
+
 volumes:
   redirect_mysql:
+  redirect_psql: