StudySync is an innovative AI-driven solution designed to help students ensure their study materials comprehensively cover their curriculum. By identifying gaps in their notes and providing targeted recommendations, StudySync helps students optimize their study time and ensures they are well-prepared for exams.
Not all students of a class raise their hands to ask their doubts! This could be because they might feel shy, they are afraid of being mocked, or just assume themselves that they know the concept. In the fast-paced world of education, students often find themselves struggling to keep up with the curriculum. Gaps in their learning materials can lead to significant challenges during exams, affecting their overall academic performance.
StudySync is an innovative solution designed to help students ensure their study materials comprehensively cover their curriculum. By leveraging the power of AI, StudySync allows students to upload their notes—whether in the form of documents, PDFs, PowerPoint presentations, or photos of handwritten notes. The AI engine processes these uploads, identifies the covered topics, and compares them against the course curriculum to highlight any gaps. Recommendations for additional resources are then provided to fill these gaps, ensuring students are well-prepared for their exams. AI generated quizzes absed on this gap helping them to build thier self confidence, and the AI generated flashcards provides them with thier personlized learning journey!
- Upload notes in various formats: documents, PDFs, PowerPoint presentations, or photos of handwritten notes.
- AI-powered text extraction and topic identification using GPT-4 API.
- Gap analysis comparing identified topics with the curriculum.
- Personalized quizzes to help students focus on uncovered topics.
- Dynamic flashcards updated based on quiz performance.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
To run this project, you need to have the following installed on your system:
- Node.js
- OpenAI API key
-
Clone the repository to your local machine:
git clone https://github.com/roshangeorge97/StudySync -
Navigate to the project directory:
cd StudySync -
Edit the .env file to enter your OpenAI API key (or) If you face any trouble in this: Enter the key directly in the server.js like in the ss below
-
Navigate to the backend directory:
cd backend -
Install the required dependencies and start the backend:
npm install npm run start -
Navigate to the frontend directory:
cd ../frontend -
Install the required dependencies and start the frontend:
npm install npm run start
- GPT-4 API: for NLP and AI-driven text analysis
- React: JavaScript library used for building user interfaces
- TailwindCSS: for styling the frontend
- Node.js: JavaScript runtime for the backend
- Express.js: web application framework for Node.js
- Firebase: for backend services
This project is licensed under the MIT License - see the LICENSE.md file for details.