Skip to content

Latest commit

 

History

History
93 lines (66 loc) · 2.69 KB

README.md

File metadata and controls

93 lines (66 loc) · 2.69 KB
Raw

NotesTaker 📝

Let NotesTaker AI take notes for you during class, so you can focus on understanding what the teacher/professor is saying, and get a clean, organized and easy to read summary at the end.

ToC 📄

About ✨

NotesTaker is a web app that uses AI to take notes for you during class. It uses the SpeechRecognition python library to convert speech to text, and then gpt4free (g4f) package to summarize the text. The frontend is built with Next.js and TailwindCSS.

Installation 🧰

Manually

  1. Clone the repo
git clone https://github.com/FujiwaraChoki/NotesTaker.git && cd NotesTaker
  1. Install node packages in frontend/ & run frontend:
cd frontend
yarn
yarn dev
  1. Install pip packages in backend/ & run backend:
cd ../backend
pip install -r requirements.txt
python app.py

With Script

  1. Clone the repo
git clone https://github.com/FujiwaraChoki/NotesTaker.git && cd NotesTaker
  1. Give start.sh executable permissions:
chmod +x start.sh
  1. Run start.sh:
./start.sh

Usage 🛠️

  1. Open localhost:3000 in your browser
  2. Press Record
  3. Start speaking or let the teacher/professor speak
  4. Once your lecture is over, simply say "stop"
  5. Wait for the AI to process your audio
  6. Refresh the page
  7. Click on the lecture you just recorded
  8. Enjoy your notes!

Contributing 🙋‍♂️

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/amazing_feature)
  3. Commit your Changes (git commit -m 'Add some amazing feature')
  4. Push to the Branch (git push origin feature/amazing_feature)
  5. Open a Pull Request

License 📑

Distributed under the MIT License. See LICENSE for more information.