Finished Postgres migration and added a docker-compose for a local DB

.env.example

@@ -4,11 +4,16 @@ NODE_ENV=development
 
 # Authentication (NextAuth.js)
 NEXTAUTH_URL=http://localhost:3000
+# https://generate-secret.vercel.app/32
 NEXTAUTH_SECRET=
 
+# https://console.cloud.google.com/apis/credentials
+# Callback URL: http://localhost:3000/api/auth/callback/google
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=
 
+# https://github.com/settings/applications
+# Callback URL: http://localhost:3000/api/auth/callback/github
 GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET=
 

.gitignore

@@ -38,3 +38,9 @@ next-env.d.ts
 # extra
 /private_docs
 .vercel
+
+# IDE
+.idea/
+
+# Docker Compose Volumes
+/data/

CONTRIBUTING.md

@@ -32,7 +32,19 @@ cp .env.example .env.local
 pnpm postinstall
 ```
 
-6. Start the development server.
+6. Start local Postgres server with Docker.
+
+```bash
+docker-compose up -d
+```
+
+7. Run the migrations.
+
+```bash
+pnpm prisma:migrate
+```
+
+8. Start the development server.
 
 ```bash
 pnpm dev

docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.8'
+services:
+  db:
+    image: postgres:13
+    restart: always
+    environment:
+      POSTGRES_USER: test_user
+      POSTGRES_PASSWORD: test_password
+      POSTGRES_DB: test_db
+    ports:
+      - 5432:5432
+    volumes:
+      - ./data:/var/lib/postgresql/data

package.json

@@ -10,6 +10,9 @@
     "lint": "next lint",
     "preview": "next build && next start",
     "postinstall": "prisma generate",
+    "prisma:generate": "prisma generate",
+    "prisma:migrate": "prisma migrate dev",
+    "prisma:studio": "prisma studio",
     "test": "jest --watch",
     "test:ci": "jest --ci",
     "format": "pnpm prettier . --write",

prisma/migrations/20230819171953_init/migration.sql

@@ -1,90 +1,109 @@
 -- CreateTable
-CREATE TABLE `accounts` (
-    `id` VARCHAR(191) NOT NULL,
-    `user_id` VARCHAR(191) NOT NULL,
-    `type` VARCHAR(191) NOT NULL,
-    `provider` VARCHAR(191) NOT NULL,
-    `provider_account_id` VARCHAR(191) NOT NULL,
-    `refresh_token` TEXT NULL,
-    `access_token` TEXT NULL,
-    `expires_at` INTEGER NULL,
-    `token_type` VARCHAR(191) NULL,
-    `scope` VARCHAR(191) NULL,
-    `id_token` TEXT NULL,
-    `session_state` VARCHAR(191) NULL,
-    `created_at` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
-    `updated_at` DATETIME(3) NOT NULL,
-
-    UNIQUE INDEX `accounts_provider_provider_account_id_key`(`provider`, `provider_account_id`),
-    PRIMARY KEY (`id`)
-) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+CREATE TABLE "accounts"
+(
+    "id"                  TEXT         NOT NULL,
+    "user_id"             TEXT         NOT NULL,
+    "type"                TEXT         NOT NULL,
+    "provider"            TEXT         NOT NULL,
+    "provider_account_id" TEXT         NOT NULL,
+    "refresh_token"       TEXT,
+    "access_token"        TEXT,
+    "expires_at"          INTEGER,
+    "token_type"          TEXT,
+    "scope"               TEXT,
+    "id_token"            TEXT,
+    "session_state"       TEXT,
+    "created_at"          TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at"          TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "accounts_pkey" PRIMARY KEY ("id")
+);
 
 -- CreateTable
-CREATE TABLE `sessions` (
-    `id` VARCHAR(191) NOT NULL,
-    `session_token` VARCHAR(191) NOT NULL,
-    `user_id` VARCHAR(191) NOT NULL,
-    `expires` DATETIME(3) NOT NULL,
+CREATE TABLE "sessions"
+(
+    "id"            TEXT         NOT NULL,
+    "session_token" TEXT         NOT NULL,
+    "user_id"       TEXT         NOT NULL,
+    "expires"       TIMESTAMP(3) NOT NULL,
 
-    UNIQUE INDEX `sessions_session_token_key`(`session_token`),
-    PRIMARY KEY (`id`)
-) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+    CONSTRAINT "sessions_pkey" PRIMARY KEY ("id")
+);
 
 -- CreateTable
-CREATE TABLE `users` (
-    `id` VARCHAR(191) NOT NULL,
-    `name` VARCHAR(191) NULL,
-    `email` VARCHAR(191) NULL,
-    `email_verified` DATETIME(3) NULL,
-    `image` VARCHAR(191) NULL,
-    `created_at` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
-    `updated_at` DATETIME(3) NOT NULL,
-
-    UNIQUE INDEX `users_email_key`(`email`),
-    PRIMARY KEY (`id`)
-) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+CREATE TABLE "users"
+(
+    "id"             TEXT         NOT NULL,
+    "name"           TEXT,
+    "email"          TEXT,
+    "email_verified" TIMESTAMP(3),
+    "image"          TEXT,
+    "created_at"     TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at"     TIMESTAMP(3) NOT NULL,
 
--- CreateTable
-CREATE TABLE `verification_tokens` (
-    `identifier` VARCHAR(191) NOT NULL,
-    `token` VARCHAR(191) NOT NULL,
-    `expires` DATETIME(3) NOT NULL,
+    CONSTRAINT "users_pkey" PRIMARY KEY ("id")
+);
 
-    UNIQUE INDEX `verification_tokens_token_key`(`token`),
-    UNIQUE INDEX `verification_tokens_identifier_token_key`(`identifier`, `token`)
-) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+-- CreateTable
+CREATE TABLE "verification_tokens"
+(
+    "identifier" TEXT         NOT NULL,
+    "token"      TEXT         NOT NULL,
+    "expires"    TIMESTAMP(3) NOT NULL
+);
 
 -- CreateTable
-CREATE TABLE `activities` (
-    `id` VARCHAR(191) NOT NULL,
-    `user_id` VARCHAR(191) NOT NULL,
-    `name` VARCHAR(191) NOT NULL,
-    `description` VARCHAR(191) NULL,
-    `color_code` VARCHAR(191) NOT NULL,
-    `created_at` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
-    `updated_at` DATETIME(3) NOT NULL,
-
-    PRIMARY KEY (`id`)
-) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+CREATE TABLE "activities"
+(
+    "id"          TEXT         NOT NULL,
+    "user_id"     TEXT         NOT NULL,
+    "name"        TEXT         NOT NULL,
+    "description" TEXT,
+    "color_code"  TEXT         NOT NULL,
+    "created_at"  TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updated_at"  TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "activities_pkey" PRIMARY KEY ("id")
+);
 
 -- CreateTable
-CREATE TABLE `activity_log` (
-    `id` VARCHAR(191) NOT NULL,
-    `activity_id` VARCHAR(191) NOT NULL,
-    `date` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
-    `count` INTEGER NOT NULL DEFAULT 1,
+CREATE TABLE "activity_log"
+(
+    "id"          TEXT         NOT NULL,
+    "activity_id" TEXT         NOT NULL,
+    "date"        TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "count"       INTEGER      NOT NULL DEFAULT 1,
+
+    CONSTRAINT "activity_log_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "accounts_provider_provider_account_id_key" ON "accounts" ("provider", "provider_account_id");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "sessions_session_token_key" ON "sessions" ("session_token");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "users_email_key" ON "users" ("email");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "verification_tokens_token_key" ON "verification_tokens" ("token");
 
-    PRIMARY KEY (`id`)
-) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+-- CreateIndex
+CREATE UNIQUE INDEX "verification_tokens_identifier_token_key" ON "verification_tokens" ("identifier", "token");
 
 -- AddForeignKey
-ALTER TABLE `accounts` ADD CONSTRAINT `accounts_user_id_fkey` FOREIGN KEY (`user_id`) REFERENCES `users`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+ALTER TABLE "accounts"
+    ADD CONSTRAINT "accounts_user_id_fkey" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE CASCADE ON UPDATE CASCADE;
 
 -- AddForeignKey
-ALTER TABLE `sessions` ADD CONSTRAINT `sessions_user_id_fkey` FOREIGN KEY (`user_id`) REFERENCES `users`(`id`) ON DELETE CASCADE ON UPDATE CASCADE;
+ALTER TABLE "sessions"
+    ADD CONSTRAINT "sessions_user_id_fkey" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE CASCADE ON UPDATE CASCADE;
 
 -- AddForeignKey
-ALTER TABLE `activities` ADD CONSTRAINT `activities_user_id_fkey` FOREIGN KEY (`user_id`) REFERENCES `users`(`id`) ON DELETE RESTRICT ON UPDATE CASCADE;
+ALTER TABLE "activities"
+    ADD CONSTRAINT "activities_user_id_fkey" FOREIGN KEY ("user_id") REFERENCES "users" ("id") ON DELETE RESTRICT ON UPDATE CASCADE;
 
 -- AddForeignKey
-ALTER TABLE `activity_log` ADD CONSTRAINT `activity_log_activity_id_fkey` FOREIGN KEY (`activity_id`) REFERENCES `activities`(`id`) ON DELETE RESTRICT ON UPDATE CASCADE;
+ALTER TABLE "activity_log"
+    ADD CONSTRAINT "activity_log_activity_id_fkey" FOREIGN KEY ("activity_id") REFERENCES "activities" ("id") ON DELETE RESTRICT ON UPDATE CASCADE;