Skip to content

Commit

Permalink
ci: update CI configuration to run tests only for API and enhance REA…
Browse files Browse the repository at this point in the history
…DME with Docker usage instructions
  • Loading branch information
remsky committed Jan 14, 2025
1 parent 832955c commit 2649a0b
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ jobs:
- name: Run Tests
run: |
uv run pytest api/tests/ ui/tests/ --asyncio-mode=auto --cov=api --cov=ui --cov-report=term-missing
uv run pytest api/tests/ --asyncio-mode=auto --cov=api --cov-report=term-missing
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,28 @@ The service can be accessed through either the API endpoints or the Gradio web i

1. Install prerequisites:
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) + [Git](https://git-scm.com/downloads)
- Clone and start the service:
- Clone the repository:
```bash
git clone https://github.com/remsky/Kokoro-FastAPI.git
cd Kokoro-FastAPI
```

2. Start the service:

a. Using Docker Compose (recommended for full setup including UI):
```bash
docker compose up --build # for GPU
#docker compose -f docker-compose.cpu.yml up --build # for CPU
```

b. Running the API alone using Docker:
```bash
# For CPU version
docker run -p 8880:8880 kokoro-fastapi-cpu
# For GPU version (requires NVIDIA Container Toolkit)
docker run --gpus all -p 8880:8880 kokoro-fastapi-gpu
```
2. Run locally as an OpenAI-Compatible Speech Endpoint
```python
from openai import OpenAI
Expand Down
1 change: 1 addition & 0 deletions docker/cpu/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
name: kokoro-tts
services:
kokoro-tts:
# image: ghcr.io/remsky/kokoro-fastapi-cpu:latest
Expand Down
1 change: 1 addition & 0 deletions docker/gpu/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
name: kokoro-tts
services:
kokoro-tts:
build:
Expand Down

0 comments on commit 2649a0b

Please sign in to comment.