35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# Chatterbox TTS Backend
|
|
|
|
This directory contains the FastAPI backend for the Chatterbox TTS application.
|
|
|
|
## Project Structure
|
|
|
|
- `app/`: Contains the main FastAPI application code.
|
|
- `__init__.py`: Makes `app` a Python package.
|
|
- `main.py`: FastAPI application instance and core API endpoints.
|
|
- `services/`: Business logic for TTS, dialog processing, etc.
|
|
- `models/`: Pydantic models for API request/response.
|
|
- `utils/`: Utility functions.
|
|
- `requirements.txt`: Project dependencies for the backend.
|
|
- `README.md`: This file.
|
|
|
|
## Setup & Running
|
|
|
|
It is assumed you have a Python virtual environment at the project root (e.g., `.venv`).
|
|
|
|
1. Navigate to the **project root** directory (e.g., `/Volumes/SAM2/CODE/chatterbox-test`).
|
|
2. Activate the existing Python virtual environment:
|
|
```bash
|
|
source .venv/bin/activate # On macOS/Linux
|
|
# .\.venv\Scripts\activate # On Windows
|
|
```
|
|
3. Install dependencies (ensure your terminal is in the **project root**):
|
|
```bash
|
|
pip install -r backend/requirements.txt
|
|
```
|
|
4. Run the development server (ensure your terminal is in the **project root**):
|
|
```bash
|
|
uvicorn backend.app.main:app --reload --host 0.0.0.0 --port 8000
|
|
```
|
|
The API should then be accessible at `http://127.0.0.1:8000`.
|