ailabs/template
1
0
Fork 0
mirror of https://github.com/samiyev/template.git synced 2025-12-27 23:16:49 +05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README with ROADMAP info

Browse Source
This commit is contained in:
imfozilbek
2025-12-22 00:40:09 +05:00
parent cca8da08cd
commit 0ef2eaec98
1 changed files with 27 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -1,10 +1,17 @@
# CLAUDE.md Template # Project Template
Standard template for Claude Code configuration files across all projects. Standard templates for Claude Code configuration across all projects.
## Files
| File | Description |
|------|-------------|
| `CLAUDE.md` | Claude Code configuration with all mandatory rules |
| `ROADMAP.md` | Monorepo roadmap template with phases and milestones |
## Usage ## Usage
1. Copy `CLAUDE.md` to your new project root 1. Copy `CLAUDE.md` and `ROADMAP.md` to your new project root
2. Replace placeholders: 2. Replace placeholders:
- `PROJECT_NAME` → your project name - `PROJECT_NAME` → your project name
- `@project/*` → your package prefix (e.g., `@myapp/*`) - `@project/*` → your package prefix (e.g., `@myapp/*`)
@@ -36,6 +43,23 @@ Standard template for Claude Code configuration files across all projects.
LIMITS: 5 params | 100 lines | 4 depth | 15 complexity 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 ## Projects Using This Template
- [RIDA](https://github.com/samiyev/rida) — TypeScript monorepo (CRM, Bot, PWA) - [RIDA](https://github.com/samiyev/rida) — TypeScript monorepo (CRM, Bot, PWA)