Skip to content

README.md

Latest commit

 

History

History
318 lines (231 loc) · 8.94 KB

README.md

File metadata and controls

318 lines (231 loc) · 8.94 KB

🚀 AI-Agnostic Development Framework

The most comprehensive AI-driven development framework - featuring 15 specialized agents, intelligent orchestration, and complete automation from planning to deployment.

License: MIT PRs Welcome

✨ What Makes This Framework Special

🤖 15 Specialized AI Agents

Unlike generic prompts, our framework includes expert agents for every phase of development:

  • Planning: Senior Engineer, Designer, Tech Spec Writer, Research Specialist
  • Documentation: Product Manager, UX/UI Designer, System Architect
  • Implementation: Backend Engineer, Frontend Engineer, QA, DevOps, Security
  • Validation: Requirements Validator, Quality Polisher

🎯 Intelligent Auto-Routing

Just type what you want - AI automatically:

  • Detects your intent
  • Selects the right agent(s)
  • Chains multiple agents when needed
  • Follows proper workflows

🔍 Automatic Quality Assurance

  • Prerequisites checking before implementation
  • Research validation for rapidly-changing tech
  • Constitution enforcement for consistency
  • Task management with dependency tracking
  • FANG-level standards built-in

🌐 AI-Agnostic

Works with any AI assistant:

  • Cursor
  • Claude (Desktop/Projects)
  • GitHub Copilot
  • ChatGPT
  • Any other AI coding assistant

🎯 Quick Start

For New Projects

# 1. Clone the framework
git clone https://github.com/Twizbee/ai-dev-framework.git .ai-framework

# 2. Run initialization script
./.ai-framework/scripts/init-new-project.sh

# 3. Copy Cursor integration
cp .ai-framework/templates/common-files/.cursorrules .cursorrules

# 4. Check prerequisites
./.ai-framework/scripts/check-prerequisites.sh

# 5. Start building!
# Open Cursor and type: "I want to build a recipe app with Next.js 15"

For Existing Projects

# 1. Clone the framework
git clone https://github.com/Twizbee/ai-dev-framework.git .ai-framework

# 2. Run refactor script
./.ai-framework/scripts/refactor-existing-project.sh

# 3. Copy Cursor integration
cp .ai-framework/templates/common-files/.cursorrules .cursorrules

# 4. Continue developing with structure!

📊 Framework Capabilities

🏗️ Complete Development Pipeline

graph LR
    A[Idea] --> B[Planning]
    B --> C[Documentation]
    C --> D[Implementation]
    D --> E[Validation]
    E --> F[Deployment]
Loading

🎨 What's Included

  • ✅ 15 Specialized Agents - Expert agents for every task
  • ✅ Intelligent Orchestrator - Auto-routing and agent chaining
  • ✅ Prerequisites Checking - Environment validation
  • ✅ Research Specialist - Technology research & validation
  • ✅ Constitution System - Persistent project decisions
  • ✅ Task Breakdown - Dependency-aware task management
  • ✅ Coding Guidelines - React Native, NestJS, TypeScript
  • ✅ Design System - 3-step methodology
  • ✅ Security Standards - Built-in best practices
  • ✅ Complete Templates - Production-ready templates

🔥 Example Workflow

You: "I want to build a task management app with Next.js 15"

AI Automatically:

1. ✓ Checking prerequisites...
   ✓ Node.js 20.0.0 installed
   ✓ npm 10.2.0 installed
   
2. ✓ Researching Next.js 15...
   → Breaking changes documented
   → Decision: Use App Router with RSC
   
3. ✓ Creating CONSTITUTION.md...
   → Tech stack: Next.js 15, PostgreSQL, Prisma
   → Standards applied
   
4. ✓ Planning architecture...
   → MVP features defined
   → Database schema designed
   
5. ✓ Generating task breakdown...
   → 24 tasks, 4 phases
   → Dependencies mapped
   
6. ✓ Ready to implement!

No manual steps! AI handles everything systematically.

📚 Documentation

Document Description
Quick Start Get started in 5 minutes
Cursor Setup 2-command Cursor integration
Complete Guide Full integration guide
Workflow Complete development workflow
Agents All 15 agent definitions
Templates Template usage guide
Index Complete documentation index

🎓 Framework Philosophy

Problem-First Approach

Start with understanding the problem before jumping to solutions. Our Product Manager agent guides you through a 5-stage discovery process.

Quality by Default

FANG-level quality standards are built-in, not optional. From TypeScript strict mode to comprehensive testing, quality is enforced automatically.

Systematic Execution

Break down complex features into dependency-aware tasks. Execute systematically with checkpoint validation at each phase.

Research-Driven Decisions

Don't guess - validate. Our Research Specialist automatically triggers for rapidly-changing technologies and documents findings.

🏆 Comparison with Other Frameworks

Feature Our Framework Spec-Kit V0.dev Bolt.new
Specialized Agents ✅ 15 agents ❌ Generic ❌ Generic ❌ Generic
AI-Agnostic ✅ Any AI ❌ Claude only ❌ Proprietary ❌ Proprietary
Prerequisites Check ✅ Built-in ✅ Built-in ❌ ❌
Research Agent ✅ Built-in ✅ Built-in ❌ ❌
Coding Guidelines ✅ 420+ lines ❌ ❌ ❌
Design System ✅ Complete ❌ ⚠️ Basic ⚠️ Basic
Security Focus ✅ Dedicated agent ❌ ❌ ❌
Multi-Phase Workflow ✅ 4 phases ❌ Linear ❌ Single-phase ❌ Single-phase

Result: Most comprehensive framework with best-of-breed features!

🛠️ Tech Stack Support

Frontend

  • ✅ React Native / Expo
  • ✅ Next.js / React
  • ✅ TypeScript (strict mode)
  • ✅ TailwindCSS / NativeWind

Backend

  • ✅ NestJS
  • ✅ Express
  • ✅ Node.js
  • ✅ TypeScript

Database

  • ✅ PostgreSQL
  • ✅ Prisma / TypeORM
  • ✅ Supabase

Testing

  • ✅ Jest
  • ✅ React Testing Library
  • ✅ Detox (E2E)

DevOps

  • ✅ Docker
  • ✅ GitHub Actions
  • ✅ Vercel / Railway

📦 What You Get

.ai-framework/
├── agents/                  # 15 specialized agents
│   ├── 00-planning/        # Planning agents
│   ├── 01-documentation/   # Documentation agents
│   ├── 02-implementation/  # Implementation agents
│   └── 03-validation/      # Validation agents
├── scripts/                 # Automation scripts
│   ├── init-new-project.sh
│   ├── refactor-existing-project.sh
│   ├── validate-structure.sh
│   └── check-prerequisites.sh
├── templates/               # Production-ready templates
│   ├── new-project/        # Project templates
│   ├── best-practices/     # Coding guidelines
│   └── common-files/       # .cursorrules, etc.
└── docs/                    # Complete documentation

🎯 Who Is This For?

✅ Perfect For:

  • Solo developers building MVPs
  • Small teams (2-5 people)
  • Startups needing rapid development
  • Developers learning best practices
  • Anyone wanting FANG-level quality

⚠️ Consider Alternatives If:

  • Enterprise teams (100+ developers)
  • Legacy codebase migration (no greenfield work)
  • Non-coding projects

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Areas We'd Love Help With:

  • Additional tech stack support (Vue, Angular, etc.)
  • More language support (Python, Go, Rust)
  • Additional agents (Mobile-specific, ML/AI-specific)
  • Community-submitted templates
  • Documentation improvements

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Inspired by GitHub spec-kit for constitution and research concepts
  • Built with insights from FANG-level engineering practices
  • Community feedback and contributions

📞 Support

🌟 Star History

If this framework helps you, please consider giving it a star! ⭐

🚀 Ready to Build?

# Quick start in 3 commands
git clone https://github.com/Twizbee/ai-dev-framework.git .ai-framework
./.ai-framework/scripts/init-new-project.sh
cp .ai-framework/templates/common-files/.cursorrules .cursorrules

# Start building!
# Open Cursor and type: "I want to build [your idea]"

Build better software, faster. 🎉

Made with ❤️ by developers, for developers