OnyxMunk/AudioForge

1# ⚡ AudioForge Quick Start
2
3**Get up and running in 5 minutes!**
4
5---
6
7## 🎯 Prerequisites
8
9- Python 3.11+
10- Node.js 18+
11- Docker (optional but recommended)
12
13---
14
15## 🚀 Setup (Choose One)
16
17### Option A: Automated Setup (Recommended)
18
19```bash
20# 1. Configure environment (includes HF token)
21python scripts/setup_env.py
22
23# 2. Start everything with Docker
24docker-compose up -d
25
26# Done! 🎉
27```
28
29**Access**:
30- Frontend: http://localhost:3000
31- Backend: http://localhost:8000
32- API Docs: http://localhost:8000/docs
33
34---
35
36### Option B: Manual Setup
37
38```bash
39# 1. Get Hugging Face token
40# Visit: https://huggingface.co/settings/tokens
41
42# 2. Configure environment
43python scripts/setup_env.py
44# (paste your HF token when prompted)
45
46# 3. Backend setup
47cd backend
48pip install -e ".[dev]"
49python scripts/init_db.py
50
51# 4. Start backend
52uvicorn app.main:app --reload
53
54# 5. Frontend setup (new terminal)
55cd frontend
56pnpm install
57pnpm dev
58```
59
60---
61
62## ✅ Verify It Works
63
64```bash
65# Check backend health
66curl http://localhost:8000/health
67
68# Check frontend
69curl http://localhost:3000
70
71# Create test generation
72curl -X POST http://localhost:8000/api/v1/generations \
73  -H "Content-Type: application/json" \
74  -d '{"prompt": "A calm acoustic guitar melody", "duration": 10}'
75```
76
77---
78
79## 📚 Key Commands
80
81### Docker
82```bash
83docker-compose up -d      # Start all services
84docker-compose ps         # Check status
85docker-compose logs -f    # View logs
86docker-compose down       # Stop everything
87```
88
89### Backend
90```bash
91cd backend
92uvicorn app.main:app --reload  # Start dev server
93pytest tests/ -v               # Run tests
94python scripts/verify_setup.py # Verify setup
95```
96
97### Frontend
98```bash
99cd frontend
100pnpm dev          # Start dev server
101pnpm build        # Production build
102pnpm test         # Run tests
103pnpm type-check   # Check TypeScript
104```
105
106---
107
108## 🎵 First Generation
109
1101. Open http://localhost:3000
1112. Enter prompt: "A dreamy lo-fi hip-hop beat"
1123. Click "Generate Music"
1134. Wait 30-60 seconds
1145. Play your generated track! 🎧
115
116---
117
118## 🐛 Troubleshooting
119
120### Backend won't start?
121```bash
122cd backend
123python scripts/verify_setup.py
124```
125
126### Frontend won't build?
127```bash
128cd frontend
129rm -rf .next node_modules
130pnpm install
131```
132
133### Models won't download?
134- Check your Hugging Face token in `backend/.env`
135- Ensure `HUGGINGFACE_TOKEN` is set
136- Check internet connection
137
138### Database error?
139```bash
140docker-compose up -d postgres
141cd backend && python scripts/init_db.py
142```
143
144---
145
146## 📖 Full Documentation
147
148- **Setup Guide**: [SETUP.md](SETUP.md)
149- **HF Token Setup**: [SETUP_HUGGINGFACE.md](SETUP_HUGGINGFACE.md)
150- **Launch Guide**: [LAUNCH_GUIDE.md](LAUNCH_GUIDE.md)
151- **Architecture**: [ARCHITECTURE.md](ARCHITECTURE.md)
152
153---
154
155## 🎉 You're Ready!
156
157**🐼⚡ Now go make some music!**
158