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