Skip to content

Commit b6508f1

Browse files
alexyknAlex // R-Kom
authored and
Alex // R-Kom
committed
Initial Commit
0 parents  commit b6508f1

27 files changed

+3938
-0
lines changed

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version_backup/
2+
node_modules/
3+
__pycache__/
4+
.venv/
5+
.vscode/
6+
.DS_Store

LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
3+
Copyright 2025 Alexander Knott, [email protected]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# TorchTS Project
2+
3+
## Overview
4+
5+
TorchTS is a text-to-speech application built with Python and Vue.js. It provides an interface for converting text from various document formats into speech using the Kokoro TTS model. The project combines a FastAPI backend with a Vue.js frontend to create a practical tool for text-to-speech conversion.
6+
7+
## Features
8+
9+
- **Text Processing:** Text handling and chunking utilities
10+
- **Document Support:** Parse and extract text from PDF, DOCX, ODT, and markdown files
11+
- **Audio Generation:** Text-to-speech conversion using Kokoro TTS
12+
- **RESTful API:** FastAPI backend endpoints for file processing and audio generation
13+
- **Modern Interface:** Vue.js frontend with Vuetify components for a responsive design
14+
15+
## Project Structure
16+
17+
```
18+
/Users/alxknt/Github/torchts
19+
├── requirements.txt # Python dependencies
20+
├── src
21+
│ └── torchts
22+
│ ├── api.py # API endpoint definitions
23+
│ ├── audio_generator.py # Audio generation utilities
24+
│ ├── document_parser.py # Document parsing utilities
25+
│ ├── text_processor.py # Text processing functionalities
26+
│ ├── main.py # Main entry point for backend
27+
│ └── templates
28+
│ └── vue # Frontend application
29+
```
30+
31+
## Installation
32+
33+
### Backend Setup (Python)
34+
35+
1. Ensure you have Python 3.7+ installed
36+
2. Install dependencies:
37+
```bash
38+
pip install -r requirements.txt
39+
```
40+
3. Start the backend server:
41+
```bash
42+
python src/torchts/main.py
43+
```
44+
45+
### Frontend Setup (Vue.js)
46+
47+
1. Navigate to the Vue directory:
48+
```bash
49+
cd src/torchts/templates/vue
50+
```
51+
2. Install dependencies:
52+
```bash
53+
npm install
54+
```
55+
3. Start development server:
56+
```bash
57+
npm run dev
58+
```
59+
60+
## Usage
61+
62+
Access the web interface at `http://localhost:5173` after starting both the backend and frontend servers. Upload text or documents and select your preferred voice to generate speech.
63+
64+
## Contributing
65+
66+
Feel free to open issues or submit pull requests if you'd like to contribute to the project.
67+
68+
## License
69+
70+
This project is licensed under the MIT License.
71+
72+
## Acknowledgments
73+
74+
- This project relies heavily on the [Kokoro-82M](https://github.com/hexgrad/kokoro) text-to-speech model created by [hexgrad](https://huggingface.co/hexgrad/Kokoro-82M). Their work on developing this high-quality TTS model made this project possible.
75+
- Built with FastAPI, Vue.js, and Vuetify

0 commit comments

Comments
 (0)