first commit

Author: tomanagle

.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+        
+      - name: Run lint
+        run: pnpm lint
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v4
+
+        - name: Setup Node.js
+          uses: actions/setup-node@v4
+          with:
+            node-version: '20'
+  
+        - name: Install pnpm
+          uses: pnpm/action-setup@v2
+          with:
+            version: 8
+            run_install: false
+  
+        - name: Install dependencies
+          run: pnpm install --frozen-lockfile
+
+        - name: Run tests
+          run: pnpm test b vgn

.gitignore

@@ -0,0 +1,3 @@
+build
+node_modules
+.env

CMD.md

@@ -0,0 +1,17 @@
+## Initalise project
+pnpm init
+
+npx tsc --init
+
+## Install dependencies
+pnpm add drizzle-orm postgres pino pino-pretty http-status-codes argon2 @fastify/secure-session @fastify/cookie fastify prom-client env-schema @fastify/swagger @fastify/swagger-ui pg-error-enum slugify fastify-type-provider-zod zod drizzle-zod
+
+
+
+pnpm add -D drizzle-kit
+
+## Install dev dependencies
+pnpm add drizzle-kit typescript tsx json-schema-to-ts @types/node vitest testcontainers @testcontainers/postgresql vitest @faker-js/faker -D
+
+## Generate session key file
+npx --yes @fastify/secure-session > session-key

Dockerfile

@@ -0,0 +1,29 @@
+# Use an official Node.js runtime as a parent image
+FROM node:20-alpine
+
+# Set the working directory
+WORKDIR /app
+
+RUN apk add --no-cache \
+    libc6-compat \
+    build-base
+
+# Copy package.json and pnpm-lock.yaml
+COPY package.json pnpm-lock.yaml ./
+
+# Install pnpm
+RUN npm install -g pnpm
+
+# Install dependencies
+RUN pnpm install
+
+# Copy the rest of the application code
+COPY . .
+
+# Build the application
+RUN pnpm build
+
+# Expose the port the app runs on
+EXPOSE 4000
+
+CMD ["node", "build/src/main.js"]

README.md

@@ -0,0 +1,113 @@
+# Build a REST API like a senior developer
+
+## What you will learn
+* Basic Principals of REST APIs
+* How to structure your applications
+* How to test REST APIs
+* How to use Docker for local development
+* How to use Drizzle for database interactions
+* How to use JSON Schema for API design
+* Basic TypeScript
+* How to capture and visualise metrics
+
+
+## Modules
+### User
+* Functional style
+* json-schema
+
+### Job
+* Object-oriented
+* Dependency injection
+* json-schema
+
+## Job application
+* Object-oriented
+* Dependency injection
+* Zod schema
+
+## Features
+* Authentication
+* User management
+* Job management
+* Metrics
+
+
+
+## Technology
+* Node.js
+* Fastify
+* Drizzle
+* Postgres
+* TypeScript
+* Pino
+* Prometheus
+* Grafana
+
+## What you'll need
+* A code editor - VSCode/Cursor
+* A HTTP client - Postman
+* Node.js installed
+* Docker installed (Optional) or a Postgres instance
+* SQL client - [TablePlus](https://tableplus.com) (Optional)
+
+## Options for Postgres
+* Docker (Recommended)
+* Local Postgres instance
+* DBngin (local) https://dbngin.com/
+* Neon (Cloud) https://neon.tech/
+* Supabase (Cloud) https://supabase.com/
+
+## Part 1 - Design
+* Database design
+* API design
+
+## Part 2 - Setup Docker (Optional)
+* Postgres
+* API
+* Dozzle (Logs)
+
+## Part 3 - Project setup
+* Install dependencies
+* Install dev dependencies
+* Initalise project
+* Setup database
+* Setup logging
+* Configure server
+
+## Part 4 - User module
+* Register user
+* Login
+* Get user
+* Testing
+
+## Part 5 - Job module
+* Create job
+* Get job
+* Update job
+* Delete job
+* Testing
+
+## Part 6 - Job application
+* Create job application
+* Get job applications for a job
+* Update job application status
+* Delete job application
+* Testing
+
+## Part 7 - Metrics
+* Setup Prometheus
+* Capture default metrics
+* Add a histogram for all requests
+* Add a custom metric for database calls
+* Visualise metrics with Grafana
+
+## Challenges
+1. Verify the user's account via email
+2. Add an OAuth flow with an identity provider like Google or GitHub
+3. Add multi-tenancy
+
+## Need help?
+Discord: https://discord.gg/4ae2Esm6P7
+Twitter: https://twitter.com/tomdoes_tech
+Bluesky: https://tomdoestech.bsky.social

WT.md

@@ -0,0 +1,21 @@
+# Building a REST API
+- [ ] Tech stack (TypeScript, Node.js, Fastify, PostgreSQL, Drizzle)
+- [ ] Routing & app structure
+- [ ] File structure
+- [ ] Developer setup (Docker, Docker Compose & Dozzle)
+- [ ] Server (Fastify)
+- [ ] Logging
+- [ ] Config & environment variables
+- [ ] Database (PostgreSQL + Drizzle)
+- [ ] Schemas & validation
+- [ ] Error handling
+- [ ] Auth (Session)
+- [ ] Observability (Prometheus, Grafana)
+- [ ] Testing (Vitest)
+- [ ] Documentation (Swagger)
+- [ ] CI/CD (GitHub Actions)
+- [ ] Deployment ([Railway](https://railway.com/), [Fly.io](https://fly.io/))
+
+# Where to get help?
+Discord: https://discord.gg/4ae2Esm6P7
+X: https://x.com/tomdoes_tech

diagram.svg

@@ -0,0 +1,31 @@
+
+services:
+  db:
+    container_name: db
+    image: postgres:13
+    ports:
+      - "5432:5432"
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=password
+      - POSTGRES_DB=postgres
+
+  api:
+    environment:
+      - DATABASE_URL=postgres://postgres:password@db:5432/postgres
+    command: >
+      sh -c "
+        pnpm db:migrate &&
+        npx nodemon -w /app/migrations -e sql -x 'pnpm db:migrate' & 
+        pnpm dev
+      "
+    volumes:
+      - .:/app
+      - /app/node_modules
+    depends_on:
+      - db
+
+volumes:
+  pgdata:

docker-compose.dev.yml

@@ -0,0 +1,54 @@
+services:
+  api:
+    container_name: api
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "4000:4000"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:4000/healthcheck"]
+      interval: 1m30s
+      timeout: 30s
+      retries: 5
+      start_period: 30s
+    volumes:
+      - ./session-keys:/app/session-keys
+
+  dozzle:
+    container_name: dozzle
+    image: amir20/dozzle:latest
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    ports:
+      - 8080:8080
+  
+  prometheus:
+    image: prom/prometheus
+    container_name: prometheus
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+    ports:
+      - 9090:9090
+    restart: unless-stopped
+    volumes:
+      - ./prometheus:/etc/prometheus
+      - prom_data:/prometheus
+
+  grafana:
+    image: grafana/grafana
+    container_name: grafana
+    ports:  
+      - 3000:3000
+    restart: unless-stopped
+    environment:
+      - GF_SECURITY_ADMIN_USER=admin
+      - GF_SECURITY_ADMIN_PASSWORD=password
+    volumes:
+      - ./grafana/provisioning:/etc/grafana/provisioning
+      - ./grafana/dashboards:/var/lib/grafana/dashboards
+      - grafana-storage:/var/lib/grafana
+
+volumes:
+  prom_data:
+  grafana-storage:

docker-compose.yml

@@ -0,0 +1,11 @@
+import { defineConfig } from "drizzle-kit";
+import { config } from "./src/config";
+
+export default defineConfig({
+  schema: "./src/db/schema.ts",
+  out: "./migrations",
+  dialect: "postgresql", // 'postgresql' | 'mysql' | 'sqlite'
+  dbCredentials: {
+    url: config.DATABASE_URL ?? "",
+  },
+});