feat: add root documentation (CLAUDE.md, AGENTS.md, .mcp.json)
This commit is contained in:
37
CLAUDE.md
Normal file
37
CLAUDE.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Clean Architecture Monorepo Template
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
pnpm install # Install all dependencies
|
||||
pnpm dev # Start all dev servers
|
||||
pnpm build # Build all packages
|
||||
pnpm test # Run all tests
|
||||
docker compose up -d # Start PostgreSQL
|
||||
```
|
||||
|
||||
## Project Overview
|
||||
|
||||
Turborepo + pnpm monorepo based on Clean Architecture (Uncle Bob / Lazar Nikolov). Supports Next.js and TanStack Start as frontend frameworks, Payload CMS for content management, and comprehensive agent-optimized documentation.
|
||||
|
||||
## Read First
|
||||
|
||||
- `AGENTS.md` — Monorepo structure, dependency flow, hard rules
|
||||
- `docs/architecture/overview.md` — High-level architecture
|
||||
- `docs/guides/adding-a-feature.md` — End-to-end walkthrough
|
||||
|
||||
## MCP Servers
|
||||
|
||||
Start Storybook before UI work: `pnpm dev --filter @repo/storybook`
|
||||
|
||||
Storybook MCP available at `http://localhost:6006/mcp` — use `list-all-documentation` to discover existing components before creating new ones.
|
||||
|
||||
## Key Ports
|
||||
|
||||
| Service | Port |
|
||||
|---|---|
|
||||
| Next.js | 3000 |
|
||||
| Payload CMS | 3001 |
|
||||
| TanStack Start | 3002 |
|
||||
| PostgreSQL | 5432 |
|
||||
| Storybook | 6006 |
|
||||
Reference in New Issue
Block a user