Skip to content

Aequor29/WhisperWrite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome to WhisperWrite

image

WhisperWrite is a powerful tool designed to process audio recordings of any length, surpassing the typical limitations of online APIs. Our tool has been tested with audio files as long as 2 hours, and it performs exceptionally well. Additionally, WhisperWrite can take notes from the audio and provide you with a summary highlighting the main points.

For more information about the project, visit our Devpost page.

Getting Started

Follow these instructions to set up and run WhisperWrite locally on your machine.

Prerequisites

Before you begin, make sure you have the following installed on your machine:

Installation

  1. Clone the repository:

    git clone https://github.com/Aequor29/WhisperWrite
  2. Navigate to the project directory:

    cd WhisperWrite/src

Setting Up the Frontend

  1. Install dependencies:

    cd frontend/whisper-write
    npm install
  2. Start the development server:

    npm run dev

Setting Up the Backend

  1. Navigate to the backend directory and install dependencies:

    cd ../backend
    pip install -r requirements.txt
  2. Set up the Python environment using virtualenv:

    virtualenv venv
    source venv/bin/activate   # On Windows use `venv\Scripts\activate`
  3. Install LLaMA2 using Ollama:

    Follow the instructions on Ollama's website to install LLaMA2.

  4. Start the backend server:

    uvicorn main:app --reload

Notes

  • Ensure both the frontend and backend servers are running simultaneously for the full functionality of WhisperWrite.
  • The backend server will handle audio processing and provide summaries based on the audio content.

Contributing

We welcome contributions! Please feel free to submit a pull request or open an issue if you have any suggestions, improvements, or find any bugs.

License

This project is licensed under the MIT License.


Thank you for using WhisperWrite! If you have any questions or need further assistance, please contact us or open an issue on GitHub.

About

A web app for Hack@Davidson

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors