Skip to content

stormsw/claude-code-starter

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Claude Code Starter

Meta-documentation framework for effective development with Claude Code and AI agents

⚠️ Important Note: This framework is designed for beginners practicing vibe-coding, not professional developers. It covers a tiny fraction of AI coding agents' capabilities and will evolve and be modified as practical experience accumulates.

πŸŽ“ Created to support students of the AI Agents course for beginners:

GitHub Version License


πŸ‡·πŸ‡Ί Русская вСрсия: README_RU.md

πŸ“ Π¨Π°Π±Π»ΠΎΠ½Ρ‹ доступны Π½Π° Π΄Π²ΡƒΡ… языках:

  • Init/ β€” русскиС ΡˆΠ°Π±Π»ΠΎΠ½Ρ‹ (Russian templates)
  • init_eng/ β€” английскиС ΡˆΠ°Π±Π»ΠΎΠ½Ρ‹ (English templates)

🎯 What is this?

Claude Code Starter is a ready-to-use meta-documentation framework that transforms chaotic AI-assisted development into a structured and efficient process.

The Problem

When working with Claude Code or other AI agents:

  • πŸ”₯ AI doesn't understand project context β†’ makes wrong architectural decisions
  • πŸ’Έ Loads entire project into context β†’ wastes tokens and money
  • πŸ”„ You explain the same things repeatedly β†’ waste time
  • 🎲 Unpredictable results β†’ no single source of truth
  • 🚫 Security issues β†’ AI doesn't know the rules

The Solution

The framework provides 11 ready-made documentation templates that:

  • βœ… Auto-load into Claude Code context (via CLAUDE.md)
  • βœ… Save tokens through modular architecture
  • βœ… Single source of truth for AI and team
  • βœ… Built-in security (SECURITY.md)
  • βœ… Slash commands for automation (/commit, /pr, /migrate, etc.)
  • βœ… Standardized processes via Makefile

πŸš€ Quick Start

1. Clone the repository

git clone https://github.com/alexeykrol/claude-code-starter.git
cd claude-code-starter

2. Copy templates to your project

# Create new project or navigate to existing one
mkdir my-new-project
cd my-new-project

# Copy all files from Init/
cp -r ../claude-code-starter/Init/* .
cp -r ../claude-code-starter/Init/.claude .

3. Fill in PROJECT_INTAKE.md

This is the most important file - start here:

# Open in editor
code PROJECT_INTAKE.md

# Or use Claude Code
claude PROJECT_INTAKE.md

Fill in key sections:

  1. Problem β†’ Solution β†’ Value - why does your project exist?
  2. User Personas - who are your users?
  3. User Flows - how will they interact?
  4. Unique vs Standard Features - what to build vs what to integrate?
  5. Modular Structure - how to break into modules?

4. Launch Claude Code

# In your project root
claude

# Claude will automatically load CLAUDE.md into context
# And read all necessary files

5. Start dialogue with AI

"Read PROJECT_INTAKE.md and ask all clarifying questions"

πŸ“¦ What's in Init/

Main Documentation Files

File Purpose When to Fill
CLAUDE.md πŸ€– Auto-loads in Claude Code Immediately, minimal edits
PROJECT_INTAKE.md ⭐ START HERE - project requirements Day 1, foundation of everything
SECURITY.md πŸ” Security rules Immediately, critical!
ARCHITECTURE.md πŸ—οΈ Architectural decisions As decisions are made
BACKLOG.md πŸ“‹ Single source of truth for status Update each sprint
AGENTS.md 🎯 Detailed AI instructions As patterns emerge
WORKFLOW.md πŸ”„ Development processes Rarely, when processes change
PLAN_TEMPLATE.md πŸ“ Planning template Use as template
README-TEMPLATE.md πŸ“– README template for project Fill and rename to README.md

Automation

File/Folder Purpose
Makefile Standardized commands (make dev, make build, etc)
.claude/commands/ Slash commands: /commit, /pr, /migrate, /security, etc
.claude/settings.json Access permissions for Claude Code
.env.example Environment variables template

🧩 Philosophy: Modular Architecture

Why modules are critical for AI work?

Monolithic approach problem:

Claude loads entire project (5000 lines) β†’
Wastes tokens reading everything β†’
Expensive and slow β†’
May get confused in large context

Solution through modules:

Claude loads only needed module (200 lines) β†’
Fewer tokens β†’
Faster and cheaper β†’
Better understanding of task

Modularity Principle

Application = Set of small LEGO blocks

Each module:

  • Solves one narrow task
  • Has clear input and output
  • Can be tested separately
  • Doesn't depend on other modules

Read more in Init/ARCHITECTURE.md (section "Module Architecture")


πŸŽ“ How to Work with the Framework

Stage 1: Project Initialization

  1. Copy templates from Init/ to your project
  2. Fill PROJECT_INTAKE.md - this is the foundation
  3. Read SECURITY.md - internalize security rules
  4. Configure Makefile for your stack (React/Vue/Node/etc)

Stage 2: Working with Claude Code

  1. Launch claude in project root
  2. CLAUDE.md auto-loads into context
  3. Ask AI to read PROJECT_INTAKE.md and ask questions
  4. Work modularly: one module β†’ testing β†’ next module

Stage 3: Maintenance and Evolution

  1. Update BACKLOG.md after each sprint
  2. Enhance ARCHITECTURE.md with architectural decisions
  3. Expand AGENTS.md with new patterns
  4. Use slash commands to automate routine tasks

πŸ’‘ Best Practices

For PROJECT_INTAKE.md

βœ… DO:

  • Start with "WHY?" - problem β†’ solution β†’ value
  • Create 2-3 User Personas with names and pain points
  • Describe User Flows step-by-step (not abstractions!)
  • Separate features into unique (build) vs standard (integrate ready-made)
  • Plan modular structure

❌ DON'T:

  • Leave [FILL IN] without filling
  • Write abstractly without specifics
  • Plan to build standard features from scratch (Auth, Payments, etc)

For working with Claude Code

βœ… DO:

  • Use /commit instead of manual commits
  • Load context via TodoWrite for task tracking
  • Work by modules: Auth β†’ API β†’ Screens β†’ Business Logic
  • Ask AI to update documentation with changes

❌ DON'T:

  • Don't load entire project into context at once
  • Don't skip SECURITY.md
  • Don't ignore architectural decisions from ARCHITECTURE.md

For security

βœ… ALWAYS:

  • Read SECURITY.md before coding
  • Use .env.example β†’ .env.local
  • Validate all input data
  • Use /security slash command for audits

❌ NEVER:

  • Commit .env files
  • Hardcode secrets in code
  • Ignore security warnings

πŸ“Š Project Structure with Framework

After copying templates, your project will look like this:

your-project/
β”œβ”€β”€ .claude/
β”‚   β”œβ”€β”€ commands/           # Slash commands (/commit, /pr, etc)
β”‚   └── settings.json       # Claude Code access permissions
β”‚
β”œβ”€β”€ src/                    # Your code
β”‚   β”œβ”€β”€ features/           # Feature modules
β”‚   β”œβ”€β”€ lib/               # Utilities and services
β”‚   └── ...
β”‚
β”œβ”€β”€ CLAUDE.md              # πŸ€– Auto-loads in Claude Code
β”œβ”€β”€ PROJECT_INTAKE.md      # ⭐ Project requirements
β”œβ”€β”€ SECURITY.md            # πŸ” Security rules
β”œβ”€β”€ ARCHITECTURE.md        # πŸ—οΈ Architectural decisions
β”œβ”€β”€ BACKLOG.md            # πŸ“‹ Implementation status
β”œβ”€β”€ AGENTS.md             # 🎯 AI instructions
β”œβ”€β”€ WORKFLOW.md           # πŸ”„ Development processes
β”œβ”€β”€ Makefile              # πŸ› οΈ Standard commands
β”œβ”€β”€ .env.example          # πŸ”’ Variables template
└── README.md             # πŸ“– Project documentation (from README-TEMPLATE.md)

πŸ”„ Framework Updates

The framework is alive and evolving. To get updates:

# In claude-code-starter folder
git pull origin main

# Compare changes and update your projects manually
diff Init/CLAUDE.md your-project/CLAUDE.md

Recommendation: Don't overwrite your filled files - copy only new sections.


🀝 Contributing

The framework is created for the community and open to improvements!

How to contribute:

  1. Fork the repository
  2. Create feature branch (git checkout -b feature/AmazingFeature)
  3. Commit changes (git commit -m 'Add some AmazingFeature')
  4. Push to branch (git push origin feature/AmazingFeature)
  5. Open Pull Request

What can be improved:

  • πŸ“ New sections in templates
  • πŸ”§ New slash commands
  • 🎨 Examples for popular stacks (Next.js, Vue, etc)
  • 🌍 Translations (already have Russian version!)
  • πŸ“– Tutorials and use cases

πŸ“š Useful Links


πŸ“œ License

MIT License - use freely in your projects!


πŸ™ Acknowledgments

Framework inspired by:

  • Official Claude Code best practices
  • Experience developing with AI agents
  • Modular architecture principles
  • Developer community

⭐ Roadmap

v1.0 (Current)

  • βœ… Basic documentation templates
  • βœ… Slash commands for git and security
  • βœ… Makefile for standardization
  • βœ… Modular architecture

v1.1 (Planned)

  • Examples for Next.js
  • Examples for Vue 3
  • English version
  • Video tutorials

v2.0 (Future)

  • CLI for automatic initialization
  • Integration with popular templates
  • VS Code plugins
  • AI-powered code review templates

πŸ’¬ Questions?

If something is unclear:

  1. Read Init/PROJECT_INTAKE.md - detailed comments there
  2. Study Init/CLAUDE.md - Quick Start there
  3. Open Issue

Happy coding with Claude! πŸ€–βœ¨

This framework turns AI-assisted development from chaos into a structured process.

About

Meta-documentation framework for AI-assisted development with Claude Code

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Makefile 100.0%