OnyxMunk/AudioForge

1# Contributing to AudioForge
2
3Thank you for your interest in contributing to AudioForge!
4
5## Development Setup
6
7### Backend
8
9```bash
10cd backend
11uv venv
12source .venv/bin/activate  # or `.venv\Scripts\activate` on Windows
13uv pip install -e ".[dev]"
14```
15
16### Frontend
17
18```bash
19cd frontend
20pnpm install
21pnpm dev
22```
23
24## Running Tests
25
26### Backend
27```bash
28cd backend
29pytest tests/ -v
30```
31
32### Frontend
33```bash
34cd frontend
35pnpm test
36```
37
38## Code Style
39
40- Backend: Black + Ruff + mypy
41- Frontend: ESLint + Prettier (via Next.js)
42
43Run formatters:
44```bash
45# Backend
46make format
47
48# Frontend
49pnpm lint --fix
50```
51
52## Architecture
53
54- **Backend**: FastAPI with async/await patterns
55- **Frontend**: Next.js 14+ with App Router
56- **Database**: PostgreSQL with SQLAlchemy async
57- **Caching**: Redis
58- **ML Models**: MusicGen, Bark
59
60## Pull Request Process
61
621. Fork the repository
632. Create a feature branch
643. Make your changes
654. Add tests
665. Ensure all tests pass
676. Submit a PR with a clear description
68