# 📚 Project Documentation - GoHorseJobs Welcome to the central documentation hub for **GoHorseJobs**. This repository contains the collective knowledge, architecture decisions, and operational guides for our B2B SaaS recruitment platform. --- ## 🧭 Navigation & Index Choose a specific domain below to dive deep into our technical implementation and guides. ### 🤖 1. AI & Developer Directives * **[Context for AI Agents (AGENTS.md)](AGENTS.md)**: The supreme source of truth for Claude, Cursor, and other AI coding assistants. Contains stack rules, passwords, gotchas, and layout contexts. * **[Rules (.agent/rules.md)](../.agent/rules.md)**: Absolute system boundaries and deployment limits. ### 🏗️ 2. High-Level Architecture * **[DevOps & Infrastructure (DEVOPS.md)](DEVOPS.md)**: Full mapping of Cloudflare DNS, Traefik, VPS (Redbull/Apolo), Docker/Coolify containers, and CI/CD pipelines (Forgejo/Drone). Includes rich Mermaid diagrams. * **[Database Schema (DATABASE.md)](DATABASE.md)**: PostgreSQL schemas, relationships, UUID v7 indexing strategies, and ERD visualizing the core data flow. ### 🔌 3. Application Interfaces (APIs) * **[API Routes (API.md)](API.md)**: Endpoints mapped for the Go Backend (`/api/v1`), NestJS Backoffice services, and internal Node.js Seeder-API. * **[API Security (API_SECURITY.md)](API_SECURITY.md)**: Details on HS256 JWT implementations, RBAC (Role-Based Access Control) levels, and CORS policies. * **[AppSec Strategy (APPSEC_STRATEGY.md)](APPSEC_STRATEGY.md)**: The core mitigation plan against XSS, IDOR, Mass Assignment, and testing vectors within Next.js. ### 🫂 4. Operations & Testing * **[Test Users & Data (TEST_USERS.md)](TEST_USERS.md)**: Comprehensive list of robust local credentials, passwords, dummy candidates, and seeded companies. * **[Deployment Routes (WORKFLOWS.md)](WORKFLOWS.md)**: A catalog of our `.forgejo` and GitHub Actions synchronizations. * **[Tasks (TASKS.md)](TASKS.md)**: Open checklist of internal improvements. --- ## 🚀 Quick Launch (Dev) If you are a new developer or setting up the environment post-clone, rely on our interactive script: ```bash cd /path/to/gohorsejobs ./start.sh ``` **Options overview**: * `1`: General Start (Frontend + Backend) * `2`: Fresh Start (Reset Postgres Data -> Run Migrations -> Seed Core Data -> Start) * `3`: God Mode (Frontend + Backend + Backoffice) --- ## 🚨 Final Notice **Do NOT** alter base configuration settings (such as encryption secrets, or Kubernetes `k3s`/`k8s` manifests) unless explicitly guided by the Lead Engineer or following the strict protocols in `.agent/rules.md`.