README.md

LearnQuest

Your Ultimate Study Hub 📖 Share, Discuss, and Generate Questions with AI-powered convenience. Elevate your learning game with ease!

Table of Contents

1. About The Project
   • Built With
2. Setting Up the Project

About The Project

Watch The Demo Video

LearnQuest is a website that helps students share study notes and generate questions based on the notes using AI. It allows students to upload their notes, which are then used by AI to generate questions. Students can also view and comment on each other's notes, which helps them to learn from each other and improve their understanding of the material.

LearnQuest provides the following features:

• Note Sharing: Users can upload and share their notes with the community.
• Comments: Users can comment on notes to provide feedback or ask questions.
• Upvoting: Users can upvote their favorite notes to show appreciation.
• Note Download: Users can download notes for offline access.
• Question Generation: Users can generate questions based on the content of the notes.
• Accessible UI: The website is made accessible so that everybody can take advantage of the website.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• 
• 
• 
• 
• 
• Django-unicorn : Django-unicorn is a Django library that integrates with the Unicorn library to provide real-time, reactive components in Django applications.
• Google Gemini API : The Google Gemini API is used to generate questions based on the content of the notes.

(back to top)

Setting Up the Project

To set up the LearnQuest project on your local machine, follow these steps:

1. Clone the repository to your local machine using the following command:

   git clone <repository-url>
   

2. Navigate to the project directory:

   cd learnquest
   

3. Create a virtual environment to isolate the project's dependencies:

   python -m venv venv
   

4. Activate the virtual environment:

   • On Windows:

     venv\Scripts\activate
     

   • On macOS and Linux:

     source venv/bin/activate
     

5. Install the project dependencies:

   pip install -r requirements.txt
   

6. Apply the database migrations:

   python manage.py migrate
   

7. Start the development server:

   python manage.py runserver
   

8. Open your web browser and visit http://localhost:8000 to access LearnQuest.

(back to top)

Usage

Sign-Up on the Website

Browse through a List of Notes Uploaded

View a Note In Detail

Generate Question Based on the notes

Upload Notes

Sign-In Page of the Website

About Page of the Website