You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> This project is for learning and testing purposes only. For production environments, please use [OpenAI's official TTS service](https://platform.openai.com/docs/guides/audio).
8
+
> This project is for learning & testing purposes only. For production use, please use the [official OpenAI TTS service](https://platform.openai.com/docs/guides/audio).
9
+
10
+
> ⚠️ **Development Notice**
11
+
> The v2 branch is currently under active development and is not recommended for production use. Please use the latest stable release version instead.
9
12
10
13
English | [中文](README_CN.md)
11
14
12
-
## 🌟 Project Introduction
15
+
## 🌟 Project Overview
13
16
14
-
TTSFM is a reverse-engineered API server that is fully compatible with OpenAI's Text-to-Speech (TTS) interface.
17
+
TTSFM is a API server that's fully compatible with OpenAI's Text-to-Speech (TTS) API format.
15
18
16
-
> 🎮 Try it now: [Official Demo Site](https://ttsapi.site/)
19
+
> 🎮 Try it now: [Official Demo](https://ttsapi.site/)
17
20
18
21
## 🏗️ Project Structure
19
22
20
23
```text
21
24
ttsfm/
22
-
├── main.py # Application entry
23
-
├── server/ # Core services
24
-
│ ├── api.py # OpenAI-compatible API
25
-
│ └── handlers.py # Request handlers
26
-
├── utils/ # Utility modules
27
-
│ └── config.py # Configuration management
28
-
├── static/ # Frontend resources
29
-
│ ├── index.html # English interface
30
-
│ ├── index_zh.html # Chinese interface
31
-
│ ├── script.js # Frontend JavaScript
32
-
│ └── styles.css # Frontend styles
33
-
├── pressure_test.py # Stress testing script
34
-
├── Dockerfile # Docker configuration
25
+
├── app.py # Main Flask application
26
+
├── celery_worker.py # Celery configuration and tasks
35
27
├── requirements.txt # Python dependencies
36
-
└── .env.example # Environment variables template
28
+
├── static/ # Frontend resources
29
+
│ ├── index.html # English interface
30
+
│ ├── index_zh.html # Chinese interface
31
+
│ ├── script.js # Frontend JavaScript
32
+
│ └── styles.css # Frontend styles
33
+
├── voices/ # Voice samples
34
+
├── Dockerfile # Docker configuration
35
+
├── docker-entrypoint.sh # Docker startup script
36
+
├── .env.example # Environment variables template
37
+
├── .env # Environment variables
38
+
├── .gitignore # Git ignore rules
39
+
├── LICENSE # MIT License
40
+
├── README.md # English documentation
41
+
├── README_CN.md # Chinese documentation
42
+
├── test_api.py # API test suite
43
+
├── test_queue.py # Queue test suite
44
+
└── .github/ # GitHub workflows
37
45
```
38
46
39
47
## 🚀 Quick Start
40
48
41
49
### System Requirements
42
-
-Python ≥ 3.8
43
-
-Or Docker environment
50
+
-Docker and Docker Compose
51
+
-or Python ≥ 3.8 with Redis
44
52
45
53
### 🐳 Docker Run (Recommended)
46
54
47
55
Basic usage:
48
56
```bash
49
-
docker run -p 7000:7000 dbcccc/ttsfm:latest
57
+
docker run -p 7000:7000 -p 6379:6379 dbcccc/ttsfm:latest
0 commit comments