คู่มือนักพัฒนา

วิธีการตั้งค่าสภาพแวดล้อมการพัฒนาในเครื่องและมีส่วนร่วมโค้ดกับ SnapOtter

สิ่งที่ต้องมีก่อน

• Node.js 22+
• pnpm 9+ (corepack enable && corepack prepare pnpm@latest --activate)
• Docker (จำเป็นสำหรับ Postgres + Redis ในเครื่อง, การ build คอนเทนเนอร์ และฟีเจอร์ AI)
• Git

ต้องมี Python 3.10+ เฉพาะเมื่อคุณกำลังทำงานกับ AI/ML sidecar (การลบพื้นหลัง, การขยายภาพ, OCR) เท่านั้น

การตั้งค่า

git clone https://github.com/snapotter-hq/snapotter.git
cd snapotter
docker compose -f docker-compose.dev.yml up -d   # start Postgres + Redis
pnpm install
pnpm dev

สิ่งนี้เริ่มต้น dev server สองตัว:

บริการ	URL	หมายเหตุ
Frontend	http://localhost:1349	Vite dev server, proxy /api
Backend	http://localhost:13490	Fastify API (เข้าถึงผ่าน proxy)

เปิด http://localhost:1349 ในเบราว์เซอร์ของคุณ เข้าสู่ระบบด้วย admin / admin คุณจะได้รับแจ้งให้เปลี่ยนรหัสผ่านตอนเข้าสู่ระบบครั้งแรก

โครงสร้างโปรเจกต์

apps/
  api/              Fastify backend
  web/              Vite + React frontend
  docs/             VitePress documentation (this site)
packages/
  shared/           Constants, types, i18n strings
  image-engine/     Sharp-based image operations
  media-engine/     FFmpeg spawn + progress parsing
  doc-engine/       qpdf, LibreOffice, ghostscript wrappers
  ai/               Python sidecar bridge for ML models
tests/
  unit/             Vitest unit tests
  integration/      Vitest integration tests (full API)
  e2e/              Playwright end-to-end specs
  fixtures/         Small test images

คำสั่ง

pnpm dev                # start frontend + backend
pnpm build              # build all workspaces
pnpm typecheck          # TypeScript check across monorepo
pnpm lint               # Biome lint + format check
pnpm lint:fix           # auto-fix lint + format
pnpm test               # unit + integration tests
pnpm test:unit          # unit tests only
pnpm test:integration   # integration tests only
pnpm test:e2e           # Playwright e2e tests
pnpm test:coverage      # tests with coverage report

แนวทางการเขียนโค้ด

• Double quotes, semicolons, การเยื้อง 2 ช่องว่าง (บังคับใช้โดย Biome)
• ES modules ในทุก workspace
• Conventional commits สำหรับ semantic-release
• Zod สำหรับการตรวจสอบอินพุต API ทั้งหมด
• ไม่แก้ไขไฟล์การตั้งค่าของ Biome, TypeScript หรือ editor แก้ไขโค้ด ไม่ใช่ linter

ฐานข้อมูล

PostgreSQL 17 ผ่าน Drizzle ORM (pg-core) การพัฒนาในเครื่องต้องมี Postgres และ Redis ทำงานอยู่ - เริ่มต้นด้วย:

docker compose -f docker-compose.dev.yml up -d

สิ่งนี้ให้ Postgres บนพอร์ต 5432 และ Redis บนพอร์ต 6379 จากนั้นสร้างและนำการย้ายข้อมูลมาใช้:

cd apps/api
npx drizzle-kit generate   # generate a migration from schema changes
npx drizzle-kit migrate    # apply pending migrations

สคีมาถูกกำหนดไว้ใน apps/api/src/db/schema.ts ตาราง: users, sessions, settings, jobs, apiKeys, pipelines, teams, userFiles, roles, auditLog

การเพิ่มเครื่องมือใหม่

ทุกเครื่องมือทำตามรูปแบบเดียวกัน นี่คือตัวอย่างขั้นต่ำ

1. Backend route

สร้าง apps/api/src/routes/tools/my-tool.ts:

import { z } from "zod";
import type { FastifyInstance } from "fastify";
import { createToolRoute } from "../tool-factory.js";

const settingsSchema = z.object({
  intensity: z.number().min(0).max(100).default(50),
});

export function registerMyTool(app: FastifyInstance) {
  createToolRoute(app, {
    toolId: "my-tool",
    settingsSchema,
    async process(inputBuffer, settings, filename) {
      // Use sharp or other libraries to process the image
      const sharp = (await import("sharp")).default;
      const result = await sharp(inputBuffer)
        // ... your processing logic
        .toBuffer();

      return {
        buffer: result,
        filename: filename.replace(/\.[^.]+$/, ".png"),
        contentType: "image/png",
      };
    },
  });
}

จากนั้นลงทะเบียนใน apps/api/src/routes/tools/index.ts

2. คอมโพเนนต์การตั้งค่า Frontend

สร้าง apps/web/src/components/tools/my-tool-settings.tsx:

import { useState } from "react";
import { useToolProcessor } from "@/hooks/use-tool-processor";
import { useFileStore } from "@/stores/file-store";

export function MyToolSettings() {
  const { files } = useFileStore();
  const { processFiles, processing, error, downloadUrl } =
    useToolProcessor("my-tool");

  const [intensity, setIntensity] = useState(50);

  const handleProcess = () => {
    processFiles(files, { intensity });
  };

  return (
    <div className="space-y-4">
      {/* your controls here */}
      <button
        type="button"
        onClick={handleProcess}
        disabled={files.length === 0 || processing}
        data-testid="my-tool-submit"
        className="w-full py-2.5 rounded-lg bg-primary text-primary-foreground font-medium disabled:opacity-50"
      >
        Process
      </button>
    </div>
  );
}

จากนั้นลงทะเบียนใน frontend tool registry ที่ apps/web/src/lib/tool-registry.tsx:

// Add the lazy import
const MyToolSettings = lazy(() =>
  import("@/components/tools/my-tool-settings").then((m) => ({
    default: m.MyToolSettings,
  })),
);

// Add to the toolRegistry Map
["my-tool", { displayMode: "before-after", Settings: MyToolSettings }],

โหมดการแสดงผล: "side-by-side", "before-after", "live-preview", "no-comparison", "interactive-crop", "interactive-eraser", "no-dropzone"

3. รายการ i18n

เพิ่มลงใน packages/shared/src/i18n/en.ts:

"my-tool": {
  name: "My Tool",
  description: "Short description of what this tool does",
},

4. เทสต์

เพิ่มแอตทริบิวต์ data-testid ให้กับปุ่มการกระทำของคุณ (ดังที่แสดงด้านบน) เพื่อให้เทสต์ e2e สามารถกำหนดเป้าหมายได้อย่างน่าเชื่อถือ

การ build Docker

Build อิมเมจโปรดักชันเต็มรูปแบบในเครื่อง:

docker build -f docker/Dockerfile -t snapotter:latest .

ใช้ BuildKit cache mount เพื่อการ rebuild ที่เร็วขึ้น:

DOCKER_BUILDKIT=1 docker build -f docker/Dockerfile -t snapotter:latest .

ตัวแปรสภาพแวดล้อม

ดู คู่มือการกำหนดค่า สำหรับรายการทั้งหมด ตัวแปรสำคัญสำหรับการพัฒนา:

ตัวแปร	ค่าเริ่มต้น	คำอธิบาย
AUTH_ENABLED	true	เปิด/ปิดการยืนยันตัวตน
DEFAULT_USERNAME	admin	ชื่อผู้ใช้ admin เริ่มต้น
DEFAULT_PASSWORD	admin	รหัสผ่าน admin เริ่มต้น
SKIP_MUST_CHANGE_PASSWORD	false	ข้ามการบังคับเปลี่ยนรหัสผ่าน (CI/dev เท่านั้น)
RATE_LIMIT_PER_MIN	1000	ขีดจำกัดอัตรา API ต่อนาที (0 = ปิด)
MAX_UPLOAD_SIZE_MB	100	ขนาดอัปโหลดสูงสุดเป็น MB (0 = ไม่จำกัด)