Project Template

Standard templates for Claude Code configuration across all projects.

Files

File Description
CLAUDE.md Claude Code configuration with all mandatory rules
ROADMAP.md Root roadmap: phases, architecture, status table
ROADMAP.package.md Package roadmap: detailed milestones
CHANGELOG.package.md Package changelog: version history
TODO.package.md Package TODO: technical debt tracker

Usage

  1. Copy to project root:
    • CLAUDE.md/CLAUDE.md
    • ROADMAP.md/ROADMAP.md
  2. Copy to each package/app:
    • ROADMAP.package.md/packages/*/ROADMAP.md
    • CHANGELOG.package.md/packages/*/CHANGELOG.md
    • TODO.package.md/packages/*/TODO.md
  3. Replace placeholders:
    • PROJECT_NAME → your project name
    • @project/* → your package prefix (e.g., @myapp/*)
    • /path/to/project → actual project path
  4. Update package table with your packages
  5. Add project-specific sections if needed
  6. Remove "Template Usage" sections

What's Included

Section Description
Code Style 4 spaces, no semicolons, double quotes
ESLint Rules 12 mandatory rules with fixes
Architecture DDD + Clean Architecture
Git Commits Conventional Commits format
Security Forbidden patterns + requirements
Testing Coverage thresholds (90/80/70%)
Database MongoDB + Redis only
Performance API < 200ms, DB < 100ms
CI/CD Pipeline stages + deploy rules
Deployment PM2 + Nginx (no Docker)

Key Rules

✅ MUST: Return types | await promises | const | curly braces | ===
❌ NEVER: any | console.log | floating promises | var | secrets in code | Docker
LIMITS: 5 params | 100 lines | 4 depth | 15 complexity

ROADMAP.md Structure

Phase 1: Foundation
├── @project/core v0.1.0 - Domain Types
│   └── Depends on: nothing
├── @project/api v0.1.0 - Infrastructure
│   └── Depends on: core v0.1.0

Phase 2: Features
├── @project/core v0.2.0 - Feature Domain
├── @project/api v0.2.0 - Feature Module
└── @project/web v0.1.0 - Setup

Dependency order: core → api → client → web

Projects Using This Template

  • RIDA — TypeScript monorepo (CRM, Bot, PWA)
  • NYAMS — AI-powered food calorie tracker
  • DBLand — NoSQL database GUI client
  • OpenNotify — Unified notification API
  • OpenPayment — Unified payment API

License

MIT

Description
No description provided
Readme 37 KiB
Languages
Markdown 100%