Giter Club home page Giter Club logo

whisper-dashboard's Introduction

Whisper Dashboard

A simple dashboard for sending translations to Whisper (Open source speech recognition model from OpenAI).

You can use this dashboard to create user accounts, upload audio files, and download the results of the speech recognition model.

This dashboard uses Node.js and Express for the backend with a React frontend. Whisper's Python API is used to run the speech recognition model.

Overview

Login screen Transcriptions list
Transcription result Admin panel

Usage

You can install this dashboard with Docker or by running the backend and frontend separately.

The first time the dashboard is started, an admin user will be created, with username "admin" and password "admin". You should change this user's password on the profile page.

As admin, you can create or delete users, manage user roles (user or admin), and view and manage transcriptions sent by all users.

Environment variables

You can configure the dashboard with the following environment variables:

Variable name Description Default value
PORT Port to run the server on 3000
JWT_SECRET Secret key for signing JWT tokens
CORS_ORIGIN If specified, the origin to allow CORS requests from
MAX_PARALLEL_TRANSCRIPTIONS Maximum number of transcriptions to run in parallel 1
WHISPER_MODEL Name of the Whisper model to use (list here) tiny

The variable CORS_ORIGIN is useful for development with the frontend running on http://localhost:5173 while the backend runs on http://localhost:3000.

Installation with Docker

With command line arguments

You can build the Docker image with:

docker build -t whisper-dashboard .

Or you can pull the image from GitHub Container Registry:

docker pull ghcr.io/gauthier-th/whisper-dashboard:latest

Then run the container with:

docker run -d \
  -p 3000:3000 \
  -e JWT_SECRET=secret \
  -e MAX_PARALLEL_TRANSCRIPTIONS=1 \
  -e WHISPER_MODEL=tiny \
  -v /path/to/data:/config \
  ghcr.io/gauthier-th/whisper-dashboard:latest

With a Docker Compose file

You can also use this Docker Compose to run the dashboard:

version: "3.8"
services:
    whisper-dashboard:
        ports:
            - '3000:3000'
        environment:
            - JWT_SECRET=secret
            - MAX_PARALLEL_TRANSCRIPTIONS=1
            - WHISPER_MODEL=tiny
        volumes:
            - '/path/to/data:/config'
        image: 'ghcr.io/gauthier-th/whisper-dashboard:latest'

Native installation

Requirements

  • Node.js 18+
  • Python 3.8+

Installation

  1. Clone the repository
  2. Install the dependencies for the backend:
    cd api
    npm install
    pip install -U openai-whisper
  3. Copy the .env.example file to .env and fill in the values from the table above. You can leave the default values.
  4. Install the dependencies for the frontend:
    cd app
    npm install
  5. Copy the .env.example file to .env and fill in this value:

Development

You should run the backend and frontend in separate terminals. The backend will run on port 3000 by default, and the frontend will run on port 5173 by default. You can use the default values of the .env.example files to get started.

  1. Start the backend:
    cd api
    npm run dev
  2. Start the frontend:
    cd app
    npm run dev

Production

  1. Build the frontend:
    cd app
    npm run build
  2. Start the backend:
    cd api
    npm start
  3. The frontend will be served from the backend at the / path.

Contributing

Pull requests are welcome! This project is still in early development, so there are many features that could be added. If you have any questions, feel free to open an issue or email me at [email protected].

License

This project is licensed under the MIT License.

whisper-dashboard's People

Contributors

gauthier-th avatar

Stargazers

 avatar  avatar  avatar Clément GHYS avatar Romain THOMAS avatar nicow avatar Tom avatar Quentin avatar

Watchers

 avatar

whisper-dashboard's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.