Spaces:
Build error
Build error
AudioForge Setup Verification Checklist
Use this checklist to verify your AudioForge installation is correct and ready to run.
β Pre-Flight Checks
Backend
- Python 3.11+ installed (
python --version) - Virtual environment created and activated
- Dependencies installed (
uv pip install -e ".[dev]") -
.envfile exists (copied from.env.example) - Storage directories exist (
storage/audio/{music,vocals,mixed,mastered}) - PostgreSQL running and accessible
- Redis running (optional but recommended)
- Database initialized (
python scripts/init_db.py)
Frontend
- Node.js 20+ installed (
node --version) - Dependencies installed (
pnpm install) -
.env.localexists withNEXT_PUBLIC_API_URL - No build errors (
pnpm buildsucceeds)
β Runtime Checks
Backend Health
# Should return: {"status":"healthy","version":"0.1.0"}
curl http://localhost:8000/health
Backend API Docs
# Should open Swagger UI
open http://localhost:8000/api/docs
Frontend
# Should open AudioForge interface
open http://localhost:3000
Database Connection
# Backend should connect without errors
# Check logs for: "database_initialized_successfully"
β Functional Tests
Test Generation Flow
- Open http://localhost:3000
- Enter prompt: "A calm acoustic guitar melody"
- Click "Generate Music"
- See generation status change: pending β processing β completed
- Audio file generated and playable
Test API Directly
# Create generation
curl -X POST http://localhost:8000/api/v1/generations \
-H "Content-Type: application/json" \
-d '{"prompt": "Test music generation"}'
# Should return generation ID and status: "pending"
β Code Quality Checks
Backend
cd backend
# Type checking
mypy app
# Linting
ruff check app
# Formatting
black --check app
# Tests
pytest tests/ -v
Frontend
cd frontend
# Type checking
pnpm type-check
# Linting
pnpm lint
# Tests
pnpm test
β Performance Checks
- Backend starts in < 5 seconds
- Frontend builds in < 30 seconds
- API responses < 100ms (excluding generation)
- No memory leaks (check with
docker stats)
β Security Checks
-
.envnot committed to git -
SECRET_KEYchanged from default - CORS configured correctly
- No sensitive data in logs
β Documentation Checks
- README.md complete
- SETUP.md complete
- ARCHITECTURE.md complete
- API docs accessible
- Code comments present
Common Issues & Solutions
Issue: Backend won't start
Check:
cd backend
python scripts/verify_setup.py
Common causes:
- Missing dependencies β
uv pip install -e ".[dev]" - Database not running β
docker-compose up -d postgres - Port 8000 in use β Change port or stop conflicting service
Issue: Frontend won't connect to backend
Check:
.env.localhas correctNEXT_PUBLIC_API_URL- Backend is running on correct port
- CORS allows frontend origin
Issue: Generation fails
Check:
- Models downloading (first time takes time)
- Sufficient disk space (~2GB for models)
- GPU/CUDA if using GPU mode
- Check backend logs for errors
Issue: Database errors
Check:
- PostgreSQL running:
docker-compose psorpg_isready - DATABASE_URL correct in
.env - Database exists:
createdb audioforgeif needed - Migrations applied:
alembic upgrade head
Verification Script
Run automated verification:
# Backend
cd backend
python scripts/verify_setup.py
# Should show all β
checks
Production Readiness
Before deploying to production:
- All tests passing
- Environment variables configured
- Database migrations applied
- Storage configured (S3 or persistent volume)
- Monitoring set up
- Logging configured
- Security review completed
- Performance tested
- Documentation updated
Success Criteria
β All checks pass β Backend responds to health check β Frontend loads without errors β Can create a generation β Generation completes successfully β Audio file is playable
If all checks pass, you're ready to go! π