Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/FujiwaraChoki/NotesTaker
A webapp to take notes during class.
https://github.com/FujiwaraChoki/NotesTaker
ai chatgpt nextjs notes summary
Last synced: about 11 hours ago
JSON representation
A webapp to take notes during class.
- Host: GitHub
- URL: https://github.com/FujiwaraChoki/NotesTaker
- Owner: FujiwaraChoki
- License: mit
- Created: 2024-01-31T18:04:44.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-11T15:31:24.000Z (9 months ago)
- Last Synced: 2024-08-02T19:37:21.524Z (3 months ago)
- Topics: ai, chatgpt, nextjs, notes, summary
- Language: JavaScript
- Homepage:
- Size: 59.6 KB
- Stars: 75
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/FujiwaraChoki/NotesTaker/tree/main?tab=readme-ov-file#license-)
- [Installation](https://github.com/FujiwaraChoki/NotesTaker/tree/main?tab=readme-ov-file#license-)
- [Manually](https://github.com/FujiwaraChoki/NotesTaker/tree/main?tab=readme-ov-file#license-)
- [With Script](https://github.com/FujiwaraChoki/NotesTaker/tree/main?tab=readme-ov-file#license-)
- [Usage](https://github.com/FujiwaraChoki/NotesTaker/tree/main?tab=readme-ov-file#license-)
- [Contributing](https://github.com/FujiwaraChoki/NotesTaker/tree/main?tab=readme-ov-file#license-)
- [License](https://github.com/FujiwaraChoki/NotesTaker/tree/main?tab=readme-ov-file#license-)
## About ✨
NotesTaker is a web app that uses AI to take notes for you during class. It uses the
[SpeechRecognition](https://pypi.org/project/SpeechRecognition/) python library to convert
speech to text, and then [gpt4free (g4f)](https://github.com/xtekky/gpt4free/) package to summarize the text. The frontend is built with
[Next.js](https://nextjs.org/) and [TailwindCSS](https://tailwindcss.com/).
## Installation 🧰
### Manually
1. Clone the repo
```sh
git clone https://github.com/FujiwaraChoki/NotesTaker.git && cd NotesTaker
```
2. Install node packages in `frontend/` & run frontend:
```sh
cd frontend
yarn
yarn dev
```
3. Install pip packages in `backend/` & run backend:
```sh
cd ../backend
pip install -r requirements.txt
python app.py
```
### With Script
1. Clone the repo
```sh
git clone https://github.com/FujiwaraChoki/NotesTaker.git && cd NotesTaker
```
2. Give `start.sh` executable permissions:
```sh
chmod +x start.sh
```
3. Run `start.sh`:
```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`](LICENSE) for more information.