From e30e48913b66b70eb762fe04632c4dae0d4c6197 Mon Sep 17 00:00:00 2001
From: elskow <elskow@outlook.com>
Date: Sun, 24 Nov 2024 18:45:52 +0700
Subject: [PATCH] docs: add local development guide and update common issues
 location

---
 docker-compose.local.yml                  |  19 ++++
 common-issues.md => docs/common-issues.md |   0
 docs/development-guide.md                 | 131 ++++++++++++++++++++++
 3 files changed, 150 insertions(+)
 create mode 100644 docker-compose.local.yml
 rename common-issues.md => docs/common-issues.md (100%)
 create mode 100644 docs/development-guide.md

diff --git a/docker-compose.local.yml b/docker-compose.local.yml
new file mode 100644
index 0000000..0d4142c
--- /dev/null
+++ b/docker-compose.local.yml
@@ -0,0 +1,19 @@
+services:
+  postgres:
+    image: postgres:16
+    environment:
+      POSTGRES_USER: tutortoise
+      POSTGRES_PASSWORD: tutortoise
+      POSTGRES_DB: tutortoise_test
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U tutortoise -d tutortoise_test"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data:
diff --git a/common-issues.md b/docs/common-issues.md
similarity index 100%
rename from common-issues.md
rename to docs/common-issues.md
diff --git a/docs/development-guide.md b/docs/development-guide.md
new file mode 100644
index 0000000..103e8b5
--- /dev/null
+++ b/docs/development-guide.md
@@ -0,0 +1,131 @@
+# Local Development Guide
+
+This guide covers how to set up and run the project in your local development environment.
+
+## Prerequisites
+
+- Node.js (v22 or later)
+- PostgreSQL (v16)
+- Docker (optional, for running PostgreSQL in container)
+- Firebase CLI
+- Google Cloud SDK (for storage emulator)
+- pnpm (v9 or later)
+
+## Environment Setup
+
+1. Clone the repository
+2. Install dependencies:
+
+   ```bash
+   pnpm install
+   ```
+
+3. Copy the example environment file:
+
+   ```bash
+   cp .env.example .env
+   ```
+
+4. Update the `.env` file with your configuration:
+
+   ```env
+   # Server
+   PORT=8080
+   CORS_ORIGIN=*
+
+   # Database
+   DATABASE_URL=postgres://tutortoise:tutortoise@localhost:5432/tutortoise_test
+
+   # Firebase
+   FIREBASE_DATABASE_URL=http://localhost:9000
+   FIREBASE_DATABASE_EMULATOR_HOST=localhost:9000
+   FIREBASE_SERVICE_ACCOUNT_KEY={"type": "service_account", ...} # Your Firebase service account key
+
+   # Google Cloud Storage
+   GCS_BUCKET_NAME=your-bucket-name
+   GOOGLE_MAPS_API_KEY=your-google-maps-api-key
+
+   # JWT
+   JWT_SECRET=your-jwt-secret
+
+   # Optional: For AI-generated content in seeders
+   GROQ_KEY=your-groq-api-key
+   ```
+
+## Database Setup
+
+### Using Docker (Recommended)
+
+1. Start the PostgreSQL container:
+
+   ```bash
+   docker compose -f docker-compose.local.yml up -d
+   ```
+
+2. Run database migrations:
+
+   ```bash
+   pnpm run db:migrate
+   ```
+
+3. (Optional) Seed the database:
+   ```bash
+   pnpm run db:seed
+   ```
+
+### Using Local PostgreSQL
+
+1. Create a new database:
+
+   ```sql
+   CREATE DATABASE tutortoise_test;
+   ```
+
+2. Create a new user:
+
+   ```sql
+   CREATE USER tutortoise WITH PASSWORD 'tutortoise';
+   GRANT ALL PRIVILEGES ON DATABASE tutortoise_test TO tutortoise;
+   ```
+
+3. Run database migrations:
+   ```bash
+   pnpm run db:migrate
+   ```
+
+## Firebase Emulators
+
+1. Install Firebase CLI if you haven't:
+
+   ```bash
+   pnpm install -g firebase-tools
+   ```
+
+2. Log in to Firebase:
+
+   ```bash
+   firebase login
+   ```
+
+3. Start the emulators:
+   ```bash
+   firebase emulators:start
+   ```
+
+This will start:
+
+- Firebase Authentication emulator on port 9099
+- Realtime Database emulator on port 9000
+- Storage emulator on port 9199
+
+## Starting the Development Server
+
+```bash
+pnpm run dev
+```
+
+The server will be available at `http://localhost:8080`
+
+## Common Issues
+
+See [common-issues.md](./common-issues.md) for solutions to common development problems.