/whisperer

This repo is one of the basic use of OpenAI APIs on the journey of AI/ML. This project takes input as a audio file and summarize it, if possible else will simply convert it to text.

Primary LanguageTypeScript

Whisperer

Whisperer is a simple AI-powered web application that uses OpenAI's Whisper API to transcribe and summarize audio files. Developed with Next.js, it allows users to upload .wav or .mp3 audio files, which are then processed, and a summary of the audio is displayed.

Features

  • Upload .wav and .mp3 audio files
  • Use OpenAI's Whisper API for transcription and summarization
  • Display the summary of the uploaded audio
  • Built with Next.js and can be deployable on Vercel

Tech Stack

  • Frontend: Next.js, React.js
  • Backend: OpenAI API (Whisper)
  • Deployment: Vercel

Installation and Setup

  1. Clone the repository:

    git clone https://github.com/ajju-raj/whisperer.git
    cd whisperer
  2. Install dependencies:

    npm install
  3. Set up environment variables:

    Create a .env.local file in the root directory and add your OpenAI API key:

    OPENAI_API_KEY=your_openai_api_key
  4. Start the development server:

    npm run dev

    The app will be running at http://localhost:3000.

Deployment

Whisperer can be easily deployed on Vercel.

  1. Push your code to a GitHub repository.
  2. Connect your GitHub repository to Vercel.
  3. Deploy the project from the Vercel dashboard.

Usage

  1. Open the app in your browser.
  2. Upload a .wav or .mp3 audio file using the file input.
  3. Click on the "Upload" button to send the file for transcription and summarization.
  4. The summary will be displayed on the screen once processing is complete.

Project Structure

  • pages/index.tsx: Main page with file upload functionality.
  • api: Backend route to handle file uploads and API calls to OpenAI's Whisper.

Contributing

Feel free to open issues or submit pull requests with improvements or new features.

License

This project is licensed under the MIT License.

Acknowledgements

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.