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
89 lines
1.6 KiB
Markdown
89 lines
1.6 KiB
Markdown
# Quick Start Guide
|
|
|
|
## Create a New Project in 3 Steps
|
|
|
|
### 1. Run Bootstrap
|
|
|
|
```bash
|
|
./bootstrap.sh my-project
|
|
```
|
|
|
|
### 2. Start Services
|
|
|
|
```bash
|
|
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
|
|
|
|
1. Edit `backend/app/api/` - Add your route
|
|
2. Edit `backend/app/services/` - Add business logic
|
|
3. Edit `backend/app/schemas/` - Define data models
|
|
4. Write tests in `backend/tests/`
|
|
|
|
### Add Your First Component
|
|
|
|
1. Create component in `frontend/src/components/`
|
|
2. Import in `frontend/src/App.tsx`
|
|
3. Write tests in `frontend/tests/`
|
|
|
|
### Run Tests
|
|
|
|
```bash
|
|
# Backend
|
|
cd backend && uv run pytest --cov=app
|
|
|
|
# Frontend
|
|
cd frontend && npm test
|
|
```
|
|
|
|
### Format Code
|
|
|
|
```bash
|
|
bash scripts/utils/format-all.sh
|
|
```
|
|
|
|
## Common Commands
|
|
|
|
```bash
|
|
# 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
|
|
```
|
|
|
|
## Need Help?
|
|
|
|
- See [USAGE.md](USAGE.md) for detailed guide
|
|
- See [README.md](README.md) for full documentation
|
|
- Check `docs/` in your project for more info
|