@sprouted/create-vibes
Version:
Create a new Vibes monorepo
100 lines (77 loc) ⢠2.2 kB
Markdown
# AI Quick Start Guide for Vibes
This guide helps AI assistants understand and work with the Vibes monorepo.
## š Initial Setup
The vibe command is already available in your project:
```bash
./vibe help
```
To add it to your PATH (optional):
```bash
./install.sh
```
## šļø Architecture Overview
Vibes uses **vertical slice architecture**:
- Each feature contains all layers (UI, API, logic, data)
- Features are independent and self-contained
- Shared code is minimal and truly generic
```
features/[feature-name]/
āāā ui/ # React components
āāā api/ # HTTP endpoints
āāā logic/ # Business logic
āāā data/ # Data models
āāā tests/ # Feature tests
```
## š§ Common Commands
### Create a new feature
```bash
./vibe create user-auth
```
### Add an app
```bash
./vibe add web # Vite web app
./vibe add mobile # Expo mobile app
./vibe add api # Go API server
```
### Development
```bash
./vibe dev # Start all apps
./vibe build # Build everything
vibe test # Run tests
```
## š Key Files
- `CLAUDE.md` - AI assistant guidelines
- `ai-docs/navigation.md` - Navigation patterns
- `ai-docs/patterns.md` - Code patterns
- `.ai/config.json` - Project metadata
## šÆ Common Tasks
### Add an API endpoint
1. Navigate to `features/[name]/api/routes/`
2. Create route file
3. Add handler in `api/handlers/`
4. Export from `api/index.ts`
### Create a UI component
1. Go to `features/[name]/ui/components/`
2. Create component (PascalCase)
3. Export from `ui/index.ts`
4. Use in screens
### Add business logic
1. Create service in `logic/services/`
2. Implement methods
3. Export from `logic/index.ts`
## š Finding Code
- Authentication: `features/user-auth/`
- API routes: `features/*/api/routes/`
- Components: `features/*/ui/components/`
- Services: `features/*/logic/services/`
## š” Best Practices
1. Keep features independent
2. Use TypeScript interfaces
3. Export through index.ts files
4. Follow existing patterns
5. Add AI-friendly comments
## š Need Help?
- Check `/docs` for detailed guides
- Look at example features
- Follow patterns in existing code
- Ask about the vibe philosophy!