Bill
8dd4f0ca63
- Bootstrap script for creating monorepo projects - FastAPI backend templates with uv, ruff, mypy, pytest - React frontend templates with TypeScript, ESLint, Prettier - Docker Compose setup with backend, frontend, and database - 9 development and CI scripts - Gitea Actions CI/CD workflows - Comprehensive documentation (8 files) - 45 template files for complete project structure - Automated verification script (all tests pass) - Based on coding-agent-rules standards
1.6 KiB
1.6 KiB
Quick Start Guide
Create a New Project in 3 Steps
1. Run Bootstrap
./bootstrap.sh my-project
2. Start Services
cd my-project
docker compose -f deploy/compose.yml up
3. Access Your Application
- Frontend: http://localhost:3000
- Backend API: http://localhost:8000
- API Docs: http://localhost:8000/docs
That's It! 🎉
Your full-stack application is now running with:
- ✅ FastAPI backend
- ✅ React frontend
- ✅ PostgreSQL database
- ✅ Hot reload enabled
- ✅ Tests configured
- ✅ CI/CD ready
What to Do Next
Add Your First API Endpoint
- Edit
backend/app/api/- Add your route - Edit
backend/app/services/- Add business logic - Edit
backend/app/schemas/- Define data models - Write tests in
backend/tests/
Add Your First Component
- Create component in
frontend/src/components/ - Import in
frontend/src/App.tsx - Write tests in
frontend/tests/
Run Tests
# Backend
cd backend && uv run pytest --cov=app
# Frontend
cd frontend && npm test
Format Code
bash scripts/utils/format-all.sh
Common Commands
# Stop services
docker compose -f deploy/compose.yml down
# View logs
docker compose -f deploy/compose.yml logs -f
# Rebuild
docker compose -f deploy/compose.yml up --build
# Run backend locally
bash scripts/dev/start-backend.sh
# Run frontend locally
bash scripts/dev/start-frontend.sh