Skip to content

linnkhant07/NoteifyMe-UCLA-HACKS23

Repository files navigation

Noteify Me

Introduction

Welcome to Noteify Me! Our platform revolutionizes studying by turning your school notes into interactive quizzes with the help of OpenAI. Create an account on our website, store your notes from different subjects, and receive daily quiz questions on Discord, get instant feedback, and enhance your learning through active recall. Say goodbye to passive studying and hello to effective learning with Noteify Me!

This is a project that my team built for the UCLA Hacks 2023 which lasted 36 hours, and I took charge of the whole backend process from the website to database and the Discord bot.

Features

  • Interactive Quizzes: Your school notes transformed into interactive quizzes.
  • Daily Quiz Questions: Receive daily quiz questions on Discord.
  • Instant Feedback: Get instant feedback on your quiz answers and explanations.
  • Active Recall: Enhance your learning through active recall techniques.

Technologies Used

  • HTML
  • CSS
  • NODEJS
  • MONGODB
  • OPENAI API
  • DISCORD API
  • EJS

Installation

To install and run Noteify Me locally, follow these steps:

  1. Clone the GitHub repository: git clone https://github.com/yourusername/NoteifyMe.git
  2. Navigate to the project directory
  3. Install dependencies
  4. Set up environment variables for the mongoDB / mongoAtlas database.
  5. Run the application:

Usage

Our website is currently not hosted right now!

To use Noteify Me, follow these steps:

  1. Create an account on the Noteify Me website.

image

  1. Upload and store notes from different subjects.

storeNotes storeNotes2

  1. Connect your Discord account to receive daily quiz questions. (CRON is set to send quizzes at 8 am every morning)

cron Image 3-31-24 at 11 01 PM

  1. Answer quiz questions and receive instant feedback.

Image 3-31-24 at 11 02 PM

Contributing

Contributions to Noteify Me are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Make your changes and ensure tests pass.
  4. Open a pull request detailing your changes.

License

This project is licensed under the MIT License.

About

Welcome to Noteify Me! Our platform revolutionizes studying by turning your school notes into interactive quizzes with the help of OpenAI. Create an account on our website, store your notes from different subjects, and receive daily quiz questions on Discord, get instant feedback, and enhance your learning through active recall.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors