0a1dc5750c
* Set up JS project * Finalise JS library * Update README * Fix package.json repository url * Rename package -> `kokoro-js` * Fix samples in README * Cleanup README * Bump `phonemizer` version * Create web demo * Run prettier * Link to model used in demo * Enable multithreading in HF space demo (~40% faster) * Add link to demo in README * Bump to v1.0.1
60 lines
1.4 KiB
Markdown
60 lines
1.4 KiB
Markdown
---
|
|
title: Kokoro Text-to-Speech
|
|
emoji: 🗣️
|
|
colorFrom: indigo
|
|
colorTo: purple
|
|
sdk: static
|
|
pinned: false
|
|
license: apache-2.0
|
|
short_description: High-quality speech synthesis powered by Kokoro TTS
|
|
header: mini
|
|
models:
|
|
- onnx-community/Kokoro-82M-ONNX
|
|
custom_headers:
|
|
cross-origin-embedder-policy: require-corp
|
|
cross-origin-opener-policy: same-origin
|
|
cross-origin-resource-policy: cross-origin
|
|
---
|
|
|
|
# Kokoro Text-to-Speech
|
|
|
|
A simple React + Vite application for running [Kokoro](https://github.com/hexgrad/kokoro), a frontier text-to-speech model for its size. The model runs 100% locally in the browser using [kokoro-js](https://www.npmjs.com/package/kokoro-js) and [🤗 Transformers.js](https://www.npmjs.com/package/@huggingface/transformers)!
|
|
|
|
## Getting Started
|
|
|
|
Follow the steps below to set up and run the application.
|
|
|
|
### 1. Clone the Repository
|
|
|
|
Clone the examples repository from GitHub:
|
|
|
|
```sh
|
|
git clone https://github.com/hexgrad/kokoro.git
|
|
```
|
|
|
|
### 2. Navigate to the Project Directory
|
|
|
|
Change your working directory to the `demo` folder:
|
|
|
|
```sh
|
|
cd kokoro/kokoro.js/demo
|
|
```
|
|
|
|
### 3. Install Dependencies
|
|
|
|
Install the necessary dependencies using npm:
|
|
|
|
```sh
|
|
npm i
|
|
```
|
|
|
|
### 4. Run the Development Server
|
|
|
|
Start the development server:
|
|
|
|
```sh
|
|
npm run dev
|
|
```
|
|
|
|
The application should now be running locally. Open your browser and go to `http://localhost:5173` to see it in action.
|