Quick Start Guide
Get your boilerplate running in 5 minutes.
Prerequisites
Install these tools first:
Verify installation:
| Bash |
|---|
| python --version # 3.11+
poetry --version # 1.0+
node --version # 18+
docker --version # 20+
task --version # 3.0+
|
Installation
| Bash |
|---|
| # 1. Extract your boilerplate zip
unzip your-tier-boilerplate.zip
cd your-tier-boilerplate
# 2. Complete automated setup
task full-setup
# 3. Update environment
cp local.env.example local.env
# Edit local.env with your values
# 4. Start development
task run-backend # Terminal 1
task run-frontend # Terminal 2
|
Access:
- Frontend: http://localhost:5173
- Backend API: http://localhost:8020
- API Docs: http://localhost:8020/docs
Tier-Specific Setup
Hustler
Basic setup only:
| Bash |
|---|
| task db:docker-start
task db:migrate-up
task run-backend
task run-frontend
|
Done! Start building.
Top G
Includes payment setup:
| Bash |
|---|
| # Basic setup
task full-setup
# Configure Stripe in local.env
STRIPE_SECRET_KEY=sk_test_...
STRIPE_PUBLISHABLE_KEY=pk_test_...
STRIPE_WEBHOOK_SECRET=whsec_...
# Initialize payments
task payments:setup
# Create admin user
task db:user-create -- --email [email protected]
|
Full payment setup
AI Velocity
Includes AI setup:
| Bash |
|---|
| # Basic setup
task full-setup
# Configure payments (same as Top G)
task payments:setup
# For Claude Code users
curl -fsSL https://claude.ai/install.sh | sh
claude
# For Cursor users
# Just open in Cursor - rules load automatically
|
AI development guide
Common Commands
| Bash |
|---|
| # Development
task run-backend
task run-frontend
task frontend:generate-client # After API changes
# Database
task db:migrate-up
task db:migrate-create -- "description"
task db:user-create # Top G+
# Payments (Top G+)
task payments:setup
task payments:products-create
# Testing
task quality:test
task quality:lint
|
More commands in Development Guide
Next Steps
- Configure environment
- Explore features
- Deploy to production
Troubleshooting
Database connection fails:
| Bash |
|---|
| task db:docker-start
# Wait 10 seconds for PostgreSQL to start
task db:migrate-up
|
Frontend won't start:
| Bash |
|---|
| cd frontend
rm -rf node_modules package-lock.json
npm install
npm run dev
|
API client out of sync:
| Bash |
|---|
| task frontend:generate-client
|
More help in FAQ
Learning Resources
New to FastAPI? Learn FastAPI for free with interactive tutorials.