docs: split CLAUDE.md into focused reference files
Move architecture, env vars, and deployment details into .claude/ subdocs referenced via @-imports, keeping CLAUDE.md to commands and pointers only. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
43
.claude/ARCHITECTURE.md
Normal file
43
.claude/ARCHITECTURE.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# Architecture
|
||||||
|
|
||||||
|
**Sistem Desa Mandiri** is a village administration platform built on Next.js 14 (App Router) with PostgreSQL.
|
||||||
|
|
||||||
|
## Key Layers
|
||||||
|
|
||||||
|
- **`src/app/(application)/`** — Auth-protected pages grouped by feature (announcement, division, project, discussion, member, profile, home, group)
|
||||||
|
- **`src/app/(auth)/`** — Login/register pages
|
||||||
|
- **`src/app/api/`** — REST API endpoints; subdirectories map to resource types (`/api/announcement`, `/api/project`, `/api/task`, etc.). Mobile-specific endpoints live under `/api/mobile/`
|
||||||
|
- **`src/module/`** — Business logic modules, one per feature (19 modules). Each module contains hooks, components, and API call functions for that domain
|
||||||
|
- **`src/lib/`** — Shared utilities: Prisma client singleton (`prisma.ts`), Firebase init, route definitions (`routes.ts`), push notification hooks
|
||||||
|
|
||||||
|
## Data Access
|
||||||
|
|
||||||
|
All DB access goes through the Prisma client singleton in `src/lib/prisma.ts`. Schema at `prisma/schema.prisma` (40+ models). Migrations in `prisma/migrations/`.
|
||||||
|
|
||||||
|
## State Management
|
||||||
|
|
||||||
|
- **Hookstate** (`@hookstate/core` + `@hookstate/localstored`) — client-side global state with localStorage persistence
|
||||||
|
- **Iron-session** — server-side session management / auth
|
||||||
|
- **Jose** — JWT handling
|
||||||
|
|
||||||
|
## UI Stack
|
||||||
|
|
||||||
|
- **Mantine 7** — primary UI library (components, forms, modals, notifications, charts, dates)
|
||||||
|
- **Tailwind CSS** — utility classes, used alongside Mantine
|
||||||
|
- **PostCSS** — configured with Mantine preset (`postcss.config.mjs`)
|
||||||
|
|
||||||
|
## Real-time & Notifications
|
||||||
|
|
||||||
|
- **Firebase FCM** (`src/lib/firebase/`) — mobile push notifications
|
||||||
|
- **Web Push + VAPID keys** (`src/lib/usePushNotifications.ts`) — browser push
|
||||||
|
- **wibu-realtime** (custom library) — WebSocket-based real-time updates
|
||||||
|
|
||||||
|
## User Roles
|
||||||
|
|
||||||
|
Five roles with distinct access levels (see `PANDUAN PENGGUNAAN.md`):
|
||||||
|
|
||||||
|
1. **Super Admin** — full system access
|
||||||
|
2. **Admin Desa** — village-level administration
|
||||||
|
3. **Ketua Divisi** — division leader
|
||||||
|
4. **Anggota Divisi** — division member
|
||||||
|
5. **Warga/Perangkat Desa** — village resident/official
|
||||||
5
.claude/DEPLOYMENT.md
Normal file
5
.claude/DEPLOYMENT.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# Deployment
|
||||||
|
|
||||||
|
Docker images are built via `.github/workflows/publish.yml` and pushed to GHCR (`ghcr.io`). Portainer redeploys via `.github/workflows/re-pull.yml`. Supports `dev`, `stg`, and `prod` stacks.
|
||||||
|
|
||||||
|
The Dockerfile uses a two-stage build: Bun builder → Bun runner (non-root user, port 3000).
|
||||||
12
.claude/ENV.md
Normal file
12
.claude/ENV.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Environment Variables
|
||||||
|
|
||||||
|
Copy `.env.example` to `.env`. Required variables:
|
||||||
|
|
||||||
|
| Variable | Purpose |
|
||||||
|
|---|---|
|
||||||
|
| `DATABASE_URL` | PostgreSQL connection string |
|
||||||
|
| `GOOGLE_PROJECT_ID`, `GOOGLE_CLIENT_EMAIL`, `GOOGLE_PRIVATE_KEY` | Firebase Admin SDK (FCM) |
|
||||||
|
| `NEXT_PUBLIC_VAPID_PUBLIC_KEY`, `VAPID_PRIVATE_KEY` | Web Push |
|
||||||
|
| `WS_APIKEY` | WebSocket/file storage API key |
|
||||||
|
| `WIBU_REALTIME_KEY` | Real-time communication |
|
||||||
|
| `FCM_KEY` | Firebase Cloud Messaging |
|
||||||
56
CLAUDE.md
56
CLAUDE.md
@@ -20,62 +20,12 @@ npx prisma generate # Regenerate Prisma client after schema changes
|
|||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
**Sistem Desa Mandiri** is a village administration platform built on Next.js 14 (App Router) with PostgreSQL.
|
See @.claude/ARCHITECTURE.md
|
||||||
|
|
||||||
### Key Layers
|
|
||||||
|
|
||||||
- **`src/app/(application)/`** — Auth-protected pages grouped by feature (announcement, division, project, discussion, member, profile, home, group)
|
|
||||||
- **`src/app/(auth)/`** — Login/register pages
|
|
||||||
- **`src/app/api/`** — REST API endpoints; subdirectories map to resource types (`/api/announcement`, `/api/project`, `/api/task`, etc.). Mobile-specific endpoints live under `/api/mobile/`
|
|
||||||
- **`src/module/`** — Business logic modules, one per feature (19 modules). Each module contains hooks, components, and API call functions for that domain
|
|
||||||
- **`src/lib/`** — Shared utilities: Prisma client singleton (`prisma.ts`), Firebase init, route definitions (`routes.ts`), push notification hooks
|
|
||||||
|
|
||||||
### Data Access Pattern
|
|
||||||
|
|
||||||
All DB access goes through the Prisma client singleton in `src/lib/prisma.ts`. Prisma schema is at `prisma/schema.prisma` (40+ models). Migrations live in `prisma/migrations/`.
|
|
||||||
|
|
||||||
### State Management
|
|
||||||
|
|
||||||
- **Hookstate** (`@hookstate/core` + `@hookstate/localstored`) for client-side global state with localStorage persistence
|
|
||||||
- **Iron-session** for server-side session management / auth
|
|
||||||
- **Jose** for JWT handling
|
|
||||||
|
|
||||||
### UI Stack
|
|
||||||
|
|
||||||
- **Mantine 7** is the primary UI library (components, forms, modals, notifications, charts, dates, etc.)
|
|
||||||
- **Tailwind CSS** for utility classes — used alongside Mantine
|
|
||||||
- **PostCSS** configured with Mantine preset (`postcss.config.mjs`)
|
|
||||||
|
|
||||||
### Real-time & Notifications
|
|
||||||
|
|
||||||
- **Firebase FCM** (`src/lib/firebase/`) for mobile push notifications
|
|
||||||
- **Web Push + VAPID keys** (`src/lib/usePushNotifications.ts`) for browser push
|
|
||||||
- **wibu-realtime** (custom library) for WebSocket-based real-time updates
|
|
||||||
|
|
||||||
### User Roles
|
|
||||||
|
|
||||||
Five roles with distinct access levels (see `PANDUAN PENGGUNAAN.md`):
|
|
||||||
1. **Super Admin** — full system access
|
|
||||||
2. **Admin Desa** — village-level administration
|
|
||||||
3. **Ketua Divisi** — division leader
|
|
||||||
4. **Anggota Divisi** — division member
|
|
||||||
5. **Warga/Perangkat Desa** — village resident/official
|
|
||||||
|
|
||||||
## Environment Variables
|
## Environment Variables
|
||||||
|
|
||||||
Copy `.env.example` to `.env`. Required variables:
|
See @.claude/ENV.md
|
||||||
|
|
||||||
| Variable | Purpose |
|
|
||||||
|---|---|
|
|
||||||
| `DATABASE_URL` | PostgreSQL connection string |
|
|
||||||
| `GOOGLE_PROJECT_ID`, `GOOGLE_CLIENT_EMAIL`, `GOOGLE_PRIVATE_KEY` | Firebase Admin SDK (FCM) |
|
|
||||||
| `NEXT_PUBLIC_VAPID_PUBLIC_KEY`, `VAPID_PRIVATE_KEY` | Web Push |
|
|
||||||
| `WS_APIKEY` | WebSocket/file storage API key |
|
|
||||||
| `WIBU_REALTIME_KEY` | Real-time communication |
|
|
||||||
| `FCM_KEY` | Firebase Cloud Messaging |
|
|
||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
Docker images are built via `.github/workflows/publish.yml` and pushed to GHCR (`ghcr.io`). Portainer redeploys via `.github/workflows/re-pull.yml`. Supports `dev`, `stg`, and `prod` stacks.
|
See @.claude/DEPLOYMENT.md
|
||||||
|
|
||||||
The Dockerfile uses a two-stage build: Bun builder → Bun runner (non-root user, port 3000).
|
|
||||||
|
|||||||
Reference in New Issue
Block a user