docs(architecture): repository-driven architecture overview (#40)

Author: mahid797

docs/architecture.md

@@ -0,0 +1,99 @@
+# Architecture Overview
+
+## 1. Purpose and scope
+This document explains how LangRoute is structured and how data flows through the system. It complements the high‑level [README](../README.md) and setup notes in [docs/getting-started.md](./getting-started.md).
+
+## 2. High-level system overview
+LangRoute exposes an OpenAI‑compatible chat API and a Next.js dashboard for administrators. Requests pass through thin API routes into service modules that coordinate model adapters and data access.
+
+```mermaid
+flowchart LR
+    Client[Web UI / SDK]
+    API[/Next.js API route/]
+    Service[Service layer]
+    Provider[LLM provider]
+    DB[(PostgreSQL)]
+
+    Client --> API --> Service --> Provider
+    Service --> DB
+```
+
+## 3. Components
+### Web UI
+- Next.js App Router under `src/app/(client)` with route groups for auth and dashboard pages. Layouts compose shared navigation and headers.
+- Global providers supply React Query, NextAuth sessions and theming `[src/app/(client)/providers/Providers.tsx]`【F:src/app/(client)/providers/Providers.tsx†L1-L55】.
+
+### API layer
+- API routes live in `src/app/(server)/api`. For example, the chat completion endpoint validates input and delegates to the chat service【F:src/app/(server)/api/chat/route.ts†L1-L32】.
+- API handlers stay thin and rely on Zod schemas for validation (`lib/validation/*`) and `withApiKey` middleware to enforce key checks【F:src/lib/middleware/apiKey.ts†L1-L41】.
+
+### Service layer
+- Business logic resides in `src/app/(server)/services`. `ChatService` validates models and outlines provider routing【F:src/app/(server)/services/chat/service.ts†L1-L87】. `ApiKeyService` encapsulates key creation and management【F:src/app/(server)/services/apiKey/service.ts†L1-L256】.
+- Services throw `ServiceError`, which routes convert into consistent JSON envelopes【F:src/app/(server)/services/system/errorService.ts†L1-L80】.
+
+### Data layer
+- Prisma client wrapper at `src/db/prisma.ts` ensures a singleton connection【F:src/db/prisma.ts†L1-L13】.
+- Database schema defines users, API keys and team tables【F:prisma/schema.prisma†L1-L125】.
+
+### Caching / realtime
+- Environment supports an optional Redis connection (`REDIS_URL`) but no runtime Redis code exists yet【F:env/.env.example†L18-L23】.
+
+### Middleware
+- Root middleware enforces session authentication and skips public routes【F:src/middleware.ts†L1-L47】.
+- Public route patterns are declared in `lib/middleware/publicRoutes.ts`【F:src/lib/middleware/publicRoutes.ts†L1-L61】.
+
+### Configuration
+- Model registry and limits live in `lib/config/llmConfig.ts`【F:src/lib/config/llmConfig.ts†L1-L40】.
+- Environment files are merged by `scripts/prepare-env.mjs` before development runs【F:scripts/prepare-env.mjs†L1-L30】.
+- Example settings reside in `env/.env.example`【F:env/.env.example†L2-L23】.
+
+## 4. Core request flows
+### Chat completions
+1. Client posts to `/api/chat`.
+2. Route validates payload with `ChatCompletionSchema` and applies API key middleware【F:src/app/(server)/api/chat/route.ts†L18-L27】.
+3. `ChatService.processCompletion` checks model config and would route to a provider (placeholder)【F:src/app/(server)/services/chat/service.ts†L45-L58】.
+4. Response returns to client; future versions may stream tokens.
+
+### Admin: create API key
+1. Dashboard page triggers `POST /api/apikeys`.
+2. Handler authenticates user and validates request【F:src/app/(server)/api/apikeys/route.ts†L35-L47】.
+3. `ApiKeyService.createApiKey` generates and stores the key via Prisma【F:src/app/(server)/services/apiKey/service.ts†L130-L150】.
+4. JSON response returns key preview for display in the UI.
+
+### Logging and error handling
+- Utility logger functions prefix messages consistently【F:src/lib/utils/logger.ts†L1-L47】.
+- API routes call `handleApiError` to log and standardize error responses【F:src/app/(server)/services/system/errorService.ts†L60-L80】.
+
+## 5. Layering and conventions
+- Routes remain thin and delegate to services; UI logic stays client-side.
+- Shared domain types live under `lib/models`【F:src/lib/models/User.ts†L1-L93】.
+- Zod schemas in `lib/validation` define request shapes used by both client and server【F:src/lib/validation/chat.schemas.ts†L1-L46】.
+
+## 6. Extensibility
+- **New provider adapter:** implement logic in `services/adapters` and have `ChatService` route to it (folder exists, implementation pending). Add provider metadata to `lib/config/llmConfig.ts`.
+- **New API route:** create a file under `src/app/(server)/api/{name}/route.ts`, add Zod schema in `lib/validation`, and call a service module.
+- **New UI feature:** add a route under `src/app/(client)/(core)` and co-locate components; export shared pieces via `components/index.ts`【F:src/app/(client)/components/index.ts†L1-L15】.
+
+## 7. Performance and reliability
+- Prisma logs can be enabled via `DEBUG_LOGS` environment variable for diagnostics【F:src/db/prisma.ts†L5-L9】.
+- Docker Compose file provisions a local PostgreSQL instance with health checks【F:docker/docker-compose.db.yml†L1-L21】.
+- Rate limiting, caching and background workers are planned but not yet implemented (see TODOs in services and env files).
+
+## 8. Security considerations
+- Authentication uses NextAuth with credential and Google providers, storing hashed passwords and roles【F:src/lib/auth.ts†L1-L80】.
+- API key middleware parses bearer tokens and rejects revoked or expired keys【F:src/lib/middleware/apiKey.ts†L10-L18】【F:src/app/(server)/services/apiKey/service.ts†L244-L255】.
+- Middleware blocks unauthenticated access except for public routes【F:src/middleware.ts†L18-L33】.
+- For additional guidance see [SECURITY.md](../SECURITY.md).
+
+## 9. Future / Planned
+- Redis-backed rate limits and live log streaming.
+- WebSocket gateway (`ws/`) and background workers (`workers/`).
+- Usage tracking service (`api/usage`) and analytics dashboards.
+
+## 10. Cross-links
+- [README](../README.md)
+- [Getting started](./getting-started.md)
+- [CONTRIBUTING](../CONTRIBUTING.md)
+- [CODE OF CONDUCT](../CODE_OF_CONDUCT.md)
+- [SECURITY](../SECURITY.md)
+- [Environment example](../env/.env.example)