✨ Configure Drizzle ORM

.env.example

@@ -0,0 +1,5 @@
+DB_HOST=localhost
+DB_PORT=3306
+DB_USER=root
+DB_PASSWORD=
+DB_NAME=ara

.gitignore

@@ -1 +1,4 @@
 node_modules
+
+.env
+.volume

README.md

@@ -1,9 +1,15 @@
 # Ara API
 
-Restful API for Ara, KAIST's official community service
+Restful API for Ara, KAIST's official community service.
 
 ## Getting Started
 
+Copy the environment variables:
+
+```bash
+cp .env.example .env
+```
+
 To install dependencies:
 
 ```bash

docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  db:
+    image: mysql:8
+    ports:
+      - '${DB_PORT:?err}:3306'
+    environment:
+      - MYSQL_ROOT_PASSWORD=${DB_PASSWORD:?err}
+      - MYSQL_DATABASE=${DB_NAME:?err}
+    volumes:
+      - ./.volume/db:/var/lib/mysql
+    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci

drizzle.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'drizzle-kit'
+
+import { env } from '@/env'
+
+export default defineConfig({
+  dialect: 'mysql',
+  schema: './src/db/schema/*',
+  out: './src/db/migration',
+  dbCredentials: {
+    host: env.DB_HOST,
+    port: env.DB_PORT,
+    user: env.DB_USER,
+    password: env.DB_PASSWORD,
+    database: env.DB_NAME,
+  },
+})

package.json

@@ -1,6 +1,9 @@
 {
   "type": "module",
   "scripts": {
+    "db:generate": "drizzle-kit generate",
+    "db:migrate": "drizzle-kit migrate",
+    "db:studio": "drizzle-kit studio",
     "dev": "bun run --hot src/index.ts",
     "prepare": "husky"
   },

src/db/index.ts

@@ -0,0 +1,14 @@
+import { drizzle } from 'drizzle-orm/mysql2'
+import { createPool } from 'mysql2/promise'
+
+import { env } from '@/env'
+
+const connectionPool = createPool({
+  host: env.DB_HOST,
+  port: env.DB_PORT,
+  user: env.DB_USER,
+  password: env.DB_PASSWORD,
+  database: env.DB_NAME,
+})
+
+export const db = drizzle(connectionPool)

src/db/migration/meta/_journal.json

@@ -0,0 +1 @@
+{ "version": "6", "dialect": "mysql", "entries": [] }

src/env.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod'
+
+export const env = z
+  .object({
+    DB_HOST: z.string(),
+    DB_PORT: z.coerce.number(),
+    DB_USER: z.string(),
+    DB_PASSWORD: z.string(),
+    DB_NAME: z.string(),
+  })
+  .parse(process.env)