Giter VIP home page Giter VIP logo

echo's Introduction

ECHO Project

An OpenAI Whisper-based full-stack project to transcribe audio and video files using React & Django.

Demo

image

image image

Installation

You need the latest versions of pipenv and node to setup this project.

  • First clone the repository git clone https://github.com/johnmiicheal/echo and navigate to the project's folder cd echo
  • Install the dependencies of both the client and server.
  • Run both the client and server separately
  • Go to http//localhost:3000 to upload and transcribe your media files.

1- To install the server's dependencies, in the terminal run the following:

** with pipenv **

  cd api
  pipenv install
  pipenv shell 
  pipenv run python manage.py makemigrations
  pipenv run python manage.py migrate
  pipenv run server

** with pip **

  cd api
  pip install -r requirements.txt
  python manage.py makemigrations
  python manage.py migrate
  python manage.py runserver

2- To run the client, execute the following commands:

  cd client
  yarn install
  touch .env.local
  yarn dev

You need to have the following env variables in your .env.local file:

NEXT_PUBLIC_ROOT_URL=http://127.0.0.1:8000
NEXT_PUBLIC_ALL_FILES_URL=http://127.0.0.1:8000/api/transcription/files/
NEXT_PUBLIC_FILE_UPLOAD_URL=http://127.0.0.1:8000/api/transcription/files/
NEXT_PUBLIC_TRANSCRIPTION_URL=ws://127.0.0.1:8000/ws/transcribe
OPENAPI=sk-youropenaiapikeygoeshere

Adjust these if your going to deploy to any remote server.

  • Navigate to http://localhost:3000/ to see if the client is working and the file upload section is visible.
  • Since this project uses websockets to send realtime-messages between the client and server, you need to see if the console of the client is showing connected, which means both client and server can exchange messages.

3- Select a video or audio file to upload The transcripts will be extracted and displayed on the page.

4- You can also view all your uploaded video and audio files and see their transcriptions. Their is an additional export button that allows you to download a JSON file with all their information.

  • Currently tested for only .mp3 files
  • Additional Notes Make sure ffmpeg is installed on your machine and available on your system's PATH

System Design

image

License

MIT

Contributing

Contributions are always welcome!

Open a PR or an issue for extra features and bug fixes.

Authors

echo's People

Contributors

ali-h-kudeir avatar johnmiicheal avatar

Watchers

 avatar

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.