-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4f11f89
commit ac29298
Showing
3 changed files
with
24 additions
and
4 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,33 @@ | ||
# `whisper-asr-webapp` | ||
|
||
[![Docker](https://github.com/FluxCapacitor2/whisper-asr-webapp/actions/workflows/docker.yml/badge.svg)](https://github.com/FluxCapacitor2/whisper-asr-webapp/actions/workflows/docker.yml) | ||
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/FluxCapacitor2/whisper-asr-webapp/main) | ||
|
||
A web app for automatic speech recognition using OpenAI's Whisper model running locally. | ||
|
||
![](/.github/readme_images/app_dark.png#gh-dark-mode-only) | ||
![](/.github/readme_images/app_light.png#gh-light-mode-only) | ||
|
||
## Features | ||
|
||
- Customize the model, language, and initial prompt | ||
- Enable per-word timestamps (visible in downloaded JSON output) | ||
- Runs Whisper locally | ||
- Pre-packaged into a single Docker image | ||
- View timestamped transcripts in the app | ||
- Download transcripts in plain text, VTT, SRT, TSV, or JSON formats | ||
|
||
## Architecture | ||
|
||
The frontend is built with Svelte and builds to static HTML, CSS, and JS. It makes requests to the backend, which is on a separate port but has permissive CORS headers. | ||
The frontend is built with Svelte and builds to static HTML, CSS, and JS. | ||
|
||
The backend is built with FastAPI. The main endpoint, `/transcribe`, pipes an uploaded file into ffmpeg, then into Whisper. Once transcription is complete, it's returned as a JSON payload. | ||
|
||
In a containerized environment, the static assets from the frontend build are served by the same FastAPI (Uvicorn) server that handles transcription. | ||
|
||
## Running | ||
|
||
1. Clone the repository. | ||
2. Run `docker compose up`. This will build and run both the frontend and backend. | ||
3. Open `http://localhost:5000` in your web browser. | ||
1. Pull and run the image with Docker. | ||
- Run in an interactive terminal: `docker run --rm -it -p 8000:8000 -v whisper_models:/root/.cache/whisper ghcr.io/fluxcapacitor2/whisper-asr-webapp:main` | ||
- Run in the background: `docker run -d -p 8000:8000 -v whisper_models:/root/.cache/whisper ghcr.io/fluxcapacitor2/whisper-asr-webapp:main` | ||
2. Visit http://localhost:8000 in a web browser |