OnyxMunk/AudioForge

1# 🎵 AudioForge - Start Here
2
3## Quick Start (Choose One)
4
5### Option 1: Docker Compose (Recommended) ⚡
6
7```bash
8# Start everything with one command
9docker-compose up -d
10
11# Check status
12docker-compose ps
13
14# View logs
15docker-compose logs -f
16```
17
18**Access:**
19- Frontend: http://localhost:3000
20- Backend API: http://localhost:8000
21- API Docs: http://localhost:8000/api/docs
22
23### Option 2: Automated Setup Script 🚀
24
25```bash
26# Backend
27cd backend
28python scripts/quick_setup.py
29
30# Then start services
31python scripts/init_db.py
32uvicorn app.main:app --reload
33
34# Frontend (new terminal)
35cd frontend
36pnpm install
37echo "NEXT_PUBLIC_API_URL=http://localhost:8000" > .env.local
38pnpm dev
39```
40
41### Option 3: Manual Setup 📝
42
43See **[SETUP.md](SETUP.md)** for detailed step-by-step instructions.
44
45## Verify Installation
46
47```bash
48# Backend verification
49cd backend
50python scripts/verify_setup.py
51
52# Health check
53curl http://localhost:8000/health
54```
55
56## First Generation
57
581. Open http://localhost:3000
592. Enter prompt: "A calm acoustic guitar melody"
603. Click "Generate Music"
614. Wait for completion (first time downloads models ~2GB)
62
63## Troubleshooting
64
65### Backend won't start?
66```bash
67cd backend
68python scripts/verify_setup.py
69```
70
71### Missing dependencies?
72```bash
73cd backend
74python scripts/quick_setup.py
75```
76
77### Database connection error?
78- Ensure PostgreSQL is running
79- Check DATABASE_URL in `.env`
80- Run: `python scripts/init_db.py`
81
82### Frontend can't connect?
83- Check NEXT_PUBLIC_API_URL in `.env.local`
84- Ensure backend is running on port 8000
85
86## Documentation
87
88- **[QUICKSTART.md](QUICKSTART.md)** - 5-minute quick start
89- **[SETUP.md](SETUP.md)** - Detailed setup guide
90- **[VERIFICATION.md](VERIFICATION.md)** - Setup checklist
91- **[ARCHITECTURE.md](ARCHITECTURE.md)** - System design
92- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Development guide
93
94## Need Help?
95
961. Check logs: `docker-compose logs -f` or backend console
972. Run verification: `python backend/scripts/verify_setup.py`
983. Review documentation files
994. Check API docs: http://localhost:8000/api/docs
100
101---
102
103**Ready to generate music?** Start with Docker Compose or run the quick setup script! 🎶
104