feat: switch to PostgreSQL

BREAKING CHANGE: Adding a PostgreSQL container is required. A reseed of the database is also required, data cannot be transferred from sqlite3 to PostgreSQL. This reseed is done automatically on first start.

Author: FreekBes

.env.example

@@ -5,3 +5,14 @@ INTRA_API_UID=enter_your_uid_here
 INTRA_API_SECRET=enter_your_secret_here
 INTRA_CAMPUS_ID=14
 INTRA_PISCINE_ASSISTANT_GROUP_ID=68
+
+POSTGRES_USER=enter_a_postgres_user_here
+POSTGRES_PASSWORD=enter_a_postgres_password_here
+POSTGRES_DB=hero
+POSTGRES_HOST=localhost
+
+# Below environment variable is used by Prisma to connect to the database
+# It should be in the format: postgresql://<POSTGRES_USER>:<POSTGRES_PASSWORD>@<POSTGRES_HOST>:5432/<POSTGRES_DB>
+# In DEVELOPMENT MODE when not using Docker to run the NodeJS code, POSTGRES_HOST should be "localhost",
+# while in PRODUCTION MODE, when Docker is used to run the NodeJS code, POSTGRES_HOST should be "codamhero-postgres" (the name of the postgres container in docker-compose.yml)
+PRISMA_DB_URL=postgresql://enter_a_postgres_user_here:enter_a_postgres_password_here@codamhero-postgres:5432/hero

.gitignore

@@ -2,6 +2,7 @@
 build/*
 dist/*
 node_modules/*
+./database
 *.db
 *.db-journal
 */.DS_Store

README.md

@@ -7,6 +7,7 @@ Only staff members or C.A.T.s have access to (parts of) piscine overviews by des
 ## Development
 To get started, run the folllowing:
 ```bash
+docker compose up -d # for the PostgresQL database
 npm install
 npm run build
 cp .env.example .env

docker-compose.yml

@@ -1,12 +1,23 @@
 version: "3"
 services:
-  codamhero:
-    build: .
+  postgres:
+    # container_name: codamhero-postgres
+    image: "postgres:15"
+    restart: unless-stopped
     ports:
-      - "4000:4000"
+      - "5432:5432"
+    env_file:
+      - .env
     volumes:
-      - ./.env:/app/.env
-      - ./hero.db:/app/hero.db
-    environment:
-      - NODE_ENV=development
-      - DEV_DAYS_LIMIT=365
+      - ./database:/var/lib/postgresql/data
+
+  # codamhero:
+  #   container_name: codamhero-web
+  #   build: .
+  #   ports:
+  #     - "4000:4000"
+  #   volumes:
+  #     - ./.env:/app/.env
+  #   environment:
+  #     - NODE_ENV=development
+  #     - DEV_DAYS_LIMIT=365