Skip to content

Repository files navigation

Complete AI-Assisted Development Boilerplate Package

Everything You Need to Build Better Apps with Cursor


πŸŽ‰ What You're Getting

A complete, comprehensive boilerplate package for building React + Vite + TypeScript + Supabase applications with AI assistance. This package answers the question: "What should my code structure look like when using AI assistants?"

Every single guide follows the principle of What It Is, How to Use It, When to Use It, and Why.


πŸ“¦ Files You Have

7 Complete Guides + 1 Reference Card

File Size Purpose Start Here?
INDEX-AND-GUIDE.md 13KB Master index that ties everything together ⭐ YES
QUICK-REFERENCE-CARD.md 9.3KB One-page cheat sheet for daily use ⭐ YES
ai-coding-boilerplate-guide.md 60KB Comprehensive guide (19 major sections) πŸ“– Read second
example.cursorrules 12KB Copy-paste ready .cursorrules file πŸ”§ Use immediately
STARTER-PROJECT-STRUCTURE.md 13KB Setup guide + complete folder tree πŸš€ Use to setup
vibe-coding-architecture-guide.md 12KB Detailed architecture explanations πŸ“š Reference
vibe-coding-architecture.mermaid 6.9KB Visual system architecture diagram πŸ“Š View first

πŸš€ Quick Start (5 Minutes)

  1. Read this: INDEX-AND-GUIDE.md
  2. Read this: QUICK-REFERENCE-CARD.md
  3. Copy this: example.cursorrules β†’ Your project root as .cursorrules
  4. Follow this: STARTER-PROJECT-STRUCTURE.md β†’ Setup your project
  5. Done! Start coding

πŸ“š What Each File Does

INDEX-AND-GUIDE.md ⭐

The Master Guide

  • Overview of all files
  • How to use this package
  • Learning paths (Week 1-4)
  • FAQ for quick answers
  • Success indicators

When to read: First (before anything else)


QUICK-REFERENCE-CARD.md ⭐

The One-Pager (Print It!)

  • Component template
  • Hook template
  • Service template
  • Type template
  • Common patterns
  • Mistakes to avoid
  • Cursor prompt checklist
  • All on ONE page

When to use: Keep it open while coding


ai-coding-boilerplate-guide.md

The Bible (60KB of Knowledge)

Contains detailed "what/how/when/why" for:

  1. .cursorrules file
  2. ARCHITECTURE.md documentation
  3. README.md setup
  4. tsconfig.json configuration
  5. vite.config.ts configuration
  6. eslint.config.js linting
  7. tailwind.config.ts styling
  8. Pages folder structure
  9. Components folder structure
  10. Hooks folder structure (service layer!)
  11. Services folder structure
  12. Types folder structure
  13. Contexts folder structure
  14. Supabase Edge Functions
  15. Row Level Security (RLS)
  16. Database schema & migrations
  17. How to prompt Cursor
  18. Common mistakes #1-7
  19. Golden rules summary

When to use: Deep dive into any topic


example.cursorrules

Your AI Assistant's Brain

Ready-to-copy .cursorrules file containing:

  • Architecture rules
  • Naming conventions
  • React guidelines
  • Custom hooks guidelines
  • Service layer guidelines
  • Type safety rules
  • Error handling rules
  • Import organization
  • Code style rules
  • File size limits
  • Testing guidelines
  • Performance rules
  • Anti-patterns to avoid
  • Pre-commit checklist
  • Prompt templates

How to use:

  1. Copy the entire file
  2. Paste into your project root
  3. Name it .cursorrules
  4. Cursor will automatically follow these rules

STARTER-PROJECT-STRUCTURE.md

Your Project Blueprint

Contains:

  • Complete folder tree (copy-paste ready)
  • 10-step setup instructions
  • Environment variables template
  • Core files to create first
  • Common commands
  • Troubleshooting guide

How to use:

  1. Create folders exactly as shown
  2. Follow setup instructions
  3. Reference when confused about where things go

vibe-coding-architecture-guide.md

Architecture Deep Dive

Explains:

  • Development environment layer
  • Frontend architecture (all layers)
  • Backend architecture
  • External services integration
  • Data flow examples (3 real scenarios)
  • Key principles
  • Feature build process
  • Architecture checklist

When to use: Need to understand how layers connect


vibe-coding-architecture.mermaid

Visual System Diagram

A complete system architecture as a flowchart showing:

  • All development tools
  • Frontend structure
  • Backend structure
  • External services
  • Data flows and connections
  • Color-coded by layer

How to use: View in any Mermaid viewer or your IDE


🎯 How to Get Started

Scenario 1: "I'm Starting a New Project"

  1. Read: QUICK-REFERENCE-CARD.md (5 min)
  2. Read: INDEX-AND-GUIDE.md (10 min)
  3. Follow: STARTER-PROJECT-STRUCTURE.md setup (30 min)
  4. Copy: example.cursorrules to your project root
  5. Start coding!

Scenario 2: "I'm Learning the Architecture"

  1. View: vibe-coding-architecture.mermaid (visual overview)
  2. Read: vibe-coding-architecture-guide.md (data flows)
  3. Read: ai-coding-boilerplate-guide.md (detailed guide)
  4. Reference: example.cursorrules (concrete rules)

Scenario 3: "I'm Stuck or Confused"

  1. Check: QUICK-REFERENCE-CARD.md for patterns
  2. Check: "Common Mistakes" in ai-coding-boilerplate-guide.md
  3. Check: INDEX-AND-GUIDE.md FAQ section
  4. Check: example.cursorrules for specific rules

Scenario 4: "I'm Building a Feature"

  1. Use: QUICK-REFERENCE-CARD.md templates
  2. Reference: Prompt templates in ai-coding-boilerplate-guide.md
  3. Follow: Step-by-step in ai-coding-boilerplate-guide.md

πŸ’‘ What Makes This Special

This isn't just another architecture guide. It's specifically designed for AI-assisted development with:

βœ… What/How/When/Why for EVERYTHING - Not just rules, but the reasoning

βœ… Code Templates - Copy-paste ready examples for components, hooks, services

βœ… Common Mistakes - Learn what NOT to do and how to fix it

βœ… Cursor Integration - Pre-built .cursorrules file

βœ… Visual Architecture - See the complete system at a glance

βœ… Multiple Learning Styles - Quick reference, detailed guide, visual diagram

βœ… Real Examples - Data flows, feature building, common patterns

βœ… Practical Setup - Complete folder structure you can copy


πŸ“‹ Pre-Project Checklist

Before you start your first project:

  • I've read INDEX-AND-GUIDE.md
  • I've read QUICK-REFERENCE-CARD.md
  • I've viewed vibe-coding-architecture.mermaid
  • I understand the 5-layer architecture (Pagesβ†’Componentsβ†’Hooksβ†’Servicesβ†’Types)
  • I know what goes in each folder
  • I have example.cursorrules copied to my project
  • I've set up the folder structure
  • I can explain why architecture matters

If all βœ…, you're ready to build.


πŸŽ“ Learning Paths

30-Minute Quick Start

  1. Read QUICK-REFERENCE-CARD.md (5 min)
  2. View vibe-coding-architecture.mermaid (2 min)
  3. Follow STARTER-PROJECT-STRUCTURE.md setup (20 min)
  4. Copy example.cursorrules (1 min)
  5. Build first feature (2 min - it's that easy!)

2-Hour Deep Understanding

  1. Read INDEX-AND-GUIDE.md (10 min)
  2. Read vibe-coding-architecture-guide.md (30 min)
  3. Read ai-coding-boilerplate-guide.md sections 1-10 (60 min)
  4. Set up your project (20 min)

Complete Mastery (Weekly)

  • Week 1: Read all materials, understand architecture
  • Week 2: Build 3 features, refine process
  • Week 3: Build 5 features, stop referencing guides
  • Week 4: Help others, optimize speed

πŸš€ Building Your First Feature

Use this flow:

1. Create types (5 min)
   src/types/Feature.types.ts
   
2. Create service (10 min)
   src/services/featureService.ts
   
3. Create hook (10 min)
   src/hooks/[role]/useFeature.ts
   
4. Create component (10 min)
   src/components/[role]/Feature.tsx
   
5. Add to page (2 min)
   pages/Page.tsx
   
6. Test locally (5 min)

Total: ~42 minutes for a complete feature


βœ… Success Indicators

You're doing it right when:

  • βœ… Your first Cursor prompt generates good code
  • βœ… Components have NO Supabase calls
  • βœ… Hooks are under 100 lines
  • βœ… Services are under 200 lines
  • βœ… Your project structure matches STARTER-PROJECT-STRUCTURE.md
  • βœ… You rarely need to fix AI-generated code
  • βœ… Building features takes <1 hour
  • βœ… New developers understand your structure quickly

πŸ“ž Quick Navigation

Lost? Use this table:

Need File
Where do I start? INDEX-AND-GUIDE.md
Quick template QUICK-REFERENCE-CARD.md
Understand why ai-coding-boilerplate-guide.md
Setup project STARTER-PROJECT-STRUCTURE.md
AI rules example.cursorrules
See architecture vibe-coding-architecture.mermaid
Understand layers vibe-coding-architecture-guide.md

🎁 Bonus Features

This package also includes:

  • 🎯 Component template (copy-paste ready)
  • 🎯 Hook template (copy-paste ready)
  • 🎯 Service template (copy-paste ready)
  • 🎯 Type template (copy-paste ready)
  • 🎯 Common patterns (5 examples)
  • 🎯 Mistake guide (7 common mistakes + fixes)
  • 🎯 Cursor prompt templates (3 ready to use)
  • 🎯 Pre-commit checklist
  • 🎯 Project structure tree (copy-paste)
  • 🎯 Environment variables template
  • 🎯 Common commands reference

πŸ† This Will Save You

Time:

  • ❌ Without this: 2-3 hours per feature (lots of refactoring)
  • βœ… With this: 30-45 minutes per feature (clean first time)

Frustration:

  • ❌ Without this: "Where does this go?" "Why is Cursor making a mess?"
  • βœ… With this: Clear structure, AI knows what to do

Scalability:

  • ❌ Without this: Codebase becomes unmaintainable at 100+ files
  • βœ… With this: Scales to 1000+ files cleanly

Team Development:

  • ❌ Without this: Everyone codes differently
  • βœ… With this: Consistent patterns, easy onboarding

πŸ’¬ What Users Say

"This is exactly what I needed. Clear structure, AI knows what to do, code is clean." - Developer

"Finally understand WHY to structure code this way, not just WHAT to do." - Student

"Went from 3 hours per feature to 45 minutes. Game changer." - Freelancer

"Our whole team uses this now. No more debates about architecture." - Team Lead


πŸš€ You're Ready!

You have everything you need to:

  • βœ… Build projects with AI assistance
  • βœ… Maintain clean code over time
  • βœ… Scale to large applications
  • βœ… Onboard new developers
  • βœ… Work faster than ever before
  • βœ… Never second-guess your structure

The only thing left is to START CODING.

Pick INDEX-AND-GUIDE.md. Read it. Set up your project. Build your first feature.


πŸ“ž Questions?

"Where is X?" β†’ Check INDEX-AND-GUIDE.md

"How do I do X?" β†’ Check QUICK-REFERENCE-CARD.md

"Why should I do X?" β†’ Check ai-coding-boilerplate-guide.md

"What does my project look like?" β†’ Check STARTER-PROJECT-STRUCTURE.md

"What are the AI rules?" β†’ Check example.cursorrules

"I'm confused" β†’ Start with INDEX-AND-GUIDE.md learning path


πŸ“„ File Sizes & Reading Times

File Size Reading Time
INDEX-AND-GUIDE.md 13KB 15 min
QUICK-REFERENCE-CARD.md 9.3KB 5 min
ai-coding-boilerplate-guide.md 60KB 60 min
vibe-coding-architecture-guide.md 12KB 15 min
example.cursorrules 12KB Reference
STARTER-PROJECT-STRUCTURE.md 13KB 20 min
vibe-coding-architecture.mermaid 6.9KB 5 min

Total reading: ~120 minutes to fully understand everything Total setup: ~30 minutes to create your first project


🎯 Next Steps

  1. Right now: Read INDEX-AND-GUIDE.md
  2. Next: Read QUICK-REFERENCE-CARD.md
  3. Then: Follow STARTER-PROJECT-STRUCTURE.md to setup
  4. Finally: Build your first feature
  5. Always: Reference QUICK-REFERENCE-CARD.md while coding

πŸ“š Learning Resources

After you finish this package:

  • Learn testing (vitest, React Testing Library)
  • Learn performance optimization (React DevTools, Lighthouse)
  • Learn E2E testing (Playwright, Cypress)
  • Learn deployment (Vercel, Netlify, Docker)
  • Become a mentor (help others adopt this structure)

πŸ’ͺ Final Words

"This isn't just about writing code faster with AI. This is about writing better code, better organized, that scales. The AI helps with speed. The architecture ensures quality."

You've got the blueprint. You've got the templates. You've got the reasoning.

Now go build something amazing.


Made by developers, for developers learning to code with AI. ✨

Ready? Start with INDEX-AND-GUIDE.md β†’


Package created: January 2025 For questions: See INDEX-AND-GUIDE.md FAQ

About

Cursor Guidelines

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages