docs: add README

This commit is contained in:
imfozilbek
2025-12-22 00:34:29 +05:00
parent 0f82413ca5
commit d900979c4e

49
README.md Normal file
View File

@@ -0,0 +1,49 @@
# CLAUDE.md Template
Standard template for Claude Code configuration files across all projects.
## Usage
1. Copy `CLAUDE.md` to your new project root
2. Replace placeholders:
- `PROJECT_NAME` → your project name
- `@project/*` → your package prefix (e.g., `@myapp/*`)
- `/path/to/project` → actual project path
3. Update package table with your packages
4. Add project-specific sections if needed
5. Remove "Template Usage" section
## 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
```
## Projects Using This Template
- [RIDA](https://github.com/samiyev/rida) — TypeScript monorepo (CRM, Bot, PWA)
- [NYAMS](https://github.com/samiyev/nyams) — AI-powered food calorie tracker
- [DBLand](https://github.com/samiyev/dbland) — NoSQL database GUI client
- [OpenNotify](https://github.com/samiyev/opennotify) — Unified notification API
- [OpenPayment](https://github.com/samiyev/openpayment) — Unified payment API
## License
MIT