AudioForge / START_HERE.md
OnyxlMunkey's picture
c618549
# 🎡 AudioForge - Start Here
## Quick Start (Choose One)
### Option 1: Docker Compose (Recommended) ⚑
```bash
# Start everything with one command
docker-compose up -d
# Check status
docker-compose ps
# View logs
docker-compose logs -f
```
**Access:**
- Frontend: http://localhost:3000
- Backend API: http://localhost:8000
- API Docs: http://localhost:8000/api/docs
### Option 2: Automated Setup Script πŸš€
```bash
# Backend
cd backend
python scripts/quick_setup.py
# Then start services
python scripts/init_db.py
uvicorn app.main:app --reload
# Frontend (new terminal)
cd frontend
pnpm install
echo "NEXT_PUBLIC_API_URL=http://localhost:8000" > .env.local
pnpm dev
```
### Option 3: Manual Setup πŸ“
See **[SETUP.md](SETUP.md)** for detailed step-by-step instructions.
## Verify Installation
```bash
# Backend verification
cd backend
python scripts/verify_setup.py
# Health check
curl http://localhost:8000/health
```
## First Generation
1. Open http://localhost:3000
2. Enter prompt: "A calm acoustic guitar melody"
3. Click "Generate Music"
4. Wait for completion (first time downloads models ~2GB)
## Troubleshooting
### Backend won't start?
```bash
cd backend
python scripts/verify_setup.py
```
### Missing dependencies?
```bash
cd backend
python scripts/quick_setup.py
```
### Database connection error?
- Ensure PostgreSQL is running
- Check DATABASE_URL in `.env`
- Run: `python scripts/init_db.py`
### Frontend can't connect?
- Check NEXT_PUBLIC_API_URL in `.env.local`
- Ensure backend is running on port 8000
## Documentation
- **[QUICKSTART.md](QUICKSTART.md)** - 5-minute quick start
- **[SETUP.md](SETUP.md)** - Detailed setup guide
- **[VERIFICATION.md](VERIFICATION.md)** - Setup checklist
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - System design
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Development guide
## Need Help?
1. Check logs: `docker-compose logs -f` or backend console
2. Run verification: `python backend/scripts/verify_setup.py`
3. Review documentation files
4. Check API docs: http://localhost:8000/api/docs
---
**Ready to generate music?** Start with Docker Compose or run the quick setup script! 🎢