Project Architecture

System Overview

[Describe your system here]

Service Map

[Client] → [API Gateway] → [Service A] → [Database A]
                         → [Service B] → [Database B]
                         → [Service C] → [Queue] → [Worker]

Key Data Flows

Flow 1: [Name — e.g. "User Authentication"]

1. Client sends credentials to /api/auth/login
2. Auth service validates against [user DB]
3. JWT issued with [claims]
4. Subsequent requests use Bearer token

Flow 2: [Name — e.g. "Order Processing"]

1. [Step 1]
2. [Step 2]
3. [Step 3]

Architecture Decisions (ADRs)

Why [Decision 1 — e.g. "Event-driven over REST for inter-service"]

• Chose: [what you chose]
• Over: [what you rejected]
• Because: [the actual reason]

Why [Decision 2]

• Chose: [what]
• Over: [what]
• Because: [why]

Boundaries & Rules

• Services communicate via [REST/gRPC/events] only
• No direct database access across services
• Shared types live in [packages/shared or similar]
• [Any other hard boundaries]

Deployment

• CI: [GitHub Actions / GitLab CI / etc]
• Staging: [how deployed]
• Production: [how deployed]
• Rollback: [procedure]