Merge branch 'main' of github.com:CS3219-AY2425S1/cs3219-ay2425s1-project-g16 into PEER-230-Login-Registration-UI

Signed-off-by: SeeuSim <[email protected]>

Author: SeeuSim

backend/user/.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+dist/

backend/user/README.md

@@ -0,0 +1,140 @@
+# Template Service
+
+This directory contains the code for the Template
+Service.
+
+## Database
+
+We use:
+
+- PostgreSQL 16 for the database. To run it, we use:
+  - Docker to run the database, as well as inject any user-defined
+    configurations or SQL files into the Docker image.
+  - Docker-Compose to run the database, as well as any other
+    services this API microservice may depend on.
+- [**Drizzle**](https://orm.drizzle.team/) for the ORM.
+
+Follow the instructions below for the setup, as well as to learn how to work with the database.
+
+### Setup
+
+1. Install Docker Desktop on your device. Launch it.
+
+2. To verify that it is launched and installed correctly, run the 
+  following in your terminal:
+
+    ```bash
+    docker --version
+    ```
+
+    If the command does not error, and outputs a version, proceed to
+    the next step.
+
+3. Inspect the `docker-compose.yml` file. It
+  should look like this:
+
+    ```yml
+    services:
+      # ...
+      postgres:
+        # ...
+        volumes:
+        - "template-db-docker:/data/template-db"
+        #  - ./init.sql:/docker-entrypoint-initdb.d/init.sql
+        ports:
+        - "5431:5432"
+        restart: unless-stopped
+
+    volumes:
+      template-db-docker:
+        external: true
+    ```
+
+    We observe that this Database relies on a 
+    Docker Volume. Replace all instances of 
+    `template-db-docker` with your desired 
+    volume name.
+
+4. Then, create the Docker Volume with
+  the following command:
+
+    ```bash
+    # in this case, the command is
+    # docker volume create template-db-docker
+    docker volume create <volume-name>
+    ```
+5. Finally, create the Database Container:
+
+    ```bash
+    docker-compose up -d
+    ```
+
+6. To bring it down, run this command:
+
+    ```bash
+    docker-compose down
+    ```
+
+### Schema
+
+We maintain the schema in the `src/lib/db/schema.ts` file.
+
+Refer to the Drizzle documentation to learn how
+to properly define schemas. Then, insert your
+schemas into the file.
+
+### Migration
+
+After you have created/updated your schemas in
+the file, persist them to the Database with
+Migrations.
+
+1. Configure your credentials (port,
+    password, ...) in:
+
+    - `drizzle.config.ts`
+    - `drizzle.migrate.mts`.
+    - `src/lib/db/index.ts`.
+
+    In the future, we may wish to migrate these
+    credentials to environment variables.
+
+2. Run the `npm run db:generate` command to
+generate your `.sql` Migration Files under the
+`drizzle` folder.
+
+3. Rename your
+    `<migration_num>_<random_name>.sql` file
+    to `<migration_num>_<meaningful_name>.sql`.
+
+    For example:
+    - Generated: `0000_dazzling_squirrel.sql`
+    - Renamed: `0000_initial_schema.sql`.
+
+    Then, rename the
+    `meta/_journal.json` tag from
+    `0000_dazzling_squirrel` to
+    `0000_initial_schema` as well. Replace the
+    migration number and name with the one you
+    used.
+
+4. Finally, run the migration with this:
+
+    ```bash
+    npm run db:migrate
+    ```
+
+### Connecting with the DB
+
+1. Import the `db` instance from `lib/db`.
+2. Use the Drizzle APIs and the tables defined in
+    `src/lib/schema.ts` to interact with the
+    tables.
+
+    ```ts
+    import { db, tableName } from '../lib/db';
+
+    const route = async (req, res) => {
+      await db.select().from(tableName); //...
+    }
+    ```

backend/user/docker-compose.yml

@@ -0,0 +1,37 @@
+services:
+  postgres:
+    hostname: postgres
+    image: "user-db"
+    container_name: "user_db"
+    build:
+      context: ./src/lib/db
+      dockerfile: ./postgres.Dockerfile
+    environment:
+      POSTGRES_DB: "User"
+      POSTGRES_USER: "user"
+      POSTGRES_PASSWORD: "user"
+      PGDATA: "/data/user-db"
+    volumes:
+       - "user-db-docker:/data/user-db"
+      #  - ./init.sql:/docker-entrypoint-initdb.d/init.sql
+    ports:
+      - "5431:5432"
+    restart: unless-stopped
+
+  express:
+    image: "user-express"
+    container_name: "user-express"
+    build:
+      context: ./
+      dockerfile: ./express.Dockerfile
+      target: build
+    ports:
+      - "8001:8001"
+    command: node dist/index.js
+    depends_on:
+      postgres:
+        condition: service_started
+        restart: true
+  
+volumes:
+  user-db-docker:

backend/user/drizzle.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from 'drizzle-kit';
+
+export default defineConfig({
+  schema: './src/lib/db/schema.ts',
+  out: './drizzle',
+  dialect: 'postgresql',
+  dbCredentials: {
+    host: 'localhost',
+    port: 5431,
+    database: 'User',
+    user: 'user',
+    password: 'user',
+  },
+});

backend/user/drizzle.migrate.mts

@@ -0,0 +1,18 @@
+import postgres from 'postgres';
+import { drizzle } from 'drizzle-orm/postgres-js';
+import { migrate } from 'drizzle-orm/postgres-js/migrator';
+
+const user = 'user';
+const password = 'user';
+const url = 'localhost';
+const database = 'User';
+const port = 5431;
+
+const CONNECTION_STRING = `postgresql://${user}:${password}@${url}:${port}/${database}`;
+
+const sql = postgres(CONNECTION_STRING, { max: 1 });
+
+const db = drizzle(sql);
+
+await migrate(db, { migrationsFolder: 'drizzle' });
+await sql.end();

backend/user/drizzle/0000_initial_schema.sql

@@ -0,0 +1,4 @@
+CREATE TABLE IF NOT EXISTS "tableName" (
+	"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
+	CONSTRAINT "tableName_id_unique" UNIQUE("id")
+);

backend/user/drizzle/0001_clammy_grandmaster.sql

@@ -0,0 +1,12 @@
+CREATE TABLE IF NOT EXISTS "users" (
+	"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
+	"email" varchar(255) NOT NULL,
+	"username" varchar(255) NOT NULL,
+	"first_name" varchar(255) NOT NULL,
+	"last_name" varchar(255) NOT NULL,
+	"password" varchar(255) NOT NULL,
+	CONSTRAINT "users_email_unique" UNIQUE("email"),
+	CONSTRAINT "users_username_unique" UNIQUE("username")
+);
+--> statement-breakpoint
+DROP TABLE "tableName";

backend/user/drizzle/meta/0000_snapshot.json

@@ -0,0 +1,41 @@
+{
+  "id": "bfb0f47d-1ebe-47d4-b979-8fe9d6305cd4",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.tableName": {
+      "name": "tableName",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "gen_random_uuid()"
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {
+        "tableName_id_unique": {
+          "name": "tableName_id_unique",
+          "nullsNotDistinct": false,
+          "columns": [
+            "id"
+          ]
+        }
+      }
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

backend/user/drizzle/meta/0001_snapshot.json

@@ -0,0 +1,78 @@
+{
+  "id": "ecf4404b-9642-42c5-b6d6-deeaeaca7a77",
+  "prevId": "bfb0f47d-1ebe-47d4-b979-8fe9d6305cd4",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.users": {
+      "name": "users",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "gen_random_uuid()"
+        },
+        "email": {
+          "name": "email",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "username": {
+          "name": "username",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "first_name": {
+          "name": "first_name",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "last_name": {
+          "name": "last_name",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "password": {
+          "name": "password",
+          "type": "varchar(255)",
+          "primaryKey": false,
+          "notNull": true
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {
+        "users_email_unique": {
+          "name": "users_email_unique",
+          "nullsNotDistinct": false,
+          "columns": [
+            "email"
+          ]
+        },
+        "users_username_unique": {
+          "name": "users_username_unique",
+          "nullsNotDistinct": false,
+          "columns": [
+            "username"
+          ]
+        }
+      }
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

backend/user/drizzle/meta/_journal.json

@@ -0,0 +1,20 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1726382290778,
+      "tag": "0000_initial_schema",
+      "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "7",
+      "when": 1726678203279,
+      "tag": "0001_clammy_grandmaster",
+      "breakpoints": true
+    }
+  ]
+}