subash-lamichhane / studymate

---

StudyMate: Your Interactive Study Companion

Overview

StudyMate is an innovative web application designed to enhance the learning experience by providing pagewise summaries of PDFs and generating interactive flashcards. With the integration of Shepherd.js, StudyMate offers a guided tour feature to help users navigate through the application's functionalities seamlessly. StudyMate makes it particularly useful for last-minute revision sessions, allowing users to quickly review key concepts and information in a structured manner.

Key Features

Interactive Guided Tour

StudyMate utilizes the Shepherd.js library to offer an interactive guided tour, ensuring that users can easily navigate and utilize the application's features. This guided tour provides step-by-step instructions and highlights key elements of the user interface, enhancing the overall user experience.

PDF Pagewise Summary

Upload a PDF to StudyMate, and it will generate a pagewise summary of the content, helping users quickly grasp the main points without having to read through the entire document.

Flashcards Generation

StudyMate allows users to create flashcards from the pdf content. Each flashcard contains a question on one side and the answer on the flip side, facilitating effective revision and learning.

Question and Answer

Ask questions about the content and get answers instantly, leveraging the power of the Gemini API to provide accurate and contextual responses.

Supported Platforms

StudyMate is a web-based application accessible on any modern web browser, making it versatile and easy to use across different devices and operating systems.

Demo

study.mp4

Getting Started

Dependencies

• Node.js
• React
• Express
• Shepherd.js
• Gemini API

Installation

Clone the Repository

git clone https://github.com/Subash-Lamichhane/StudyMate.git

Frontend Setup

Navigate to the frontend directory and install dependencies:

cd StudyMate/frontend
yarn

Start the development server:

yarn run dev

Backend Setup

Navigate to the server directory and install dependencies:

cd ../server
yarn install

Set up the environment variables by creating a .env.local file in the server directory and add your Gemini API key:

API_KEY=AIzaS*************

Start the backend server:

yarn start

Usage

Visit the frontend application by opening your browser and navigating to:

http://localhost:5173/

Ensure the backend server is running at:

http://localhost:3000

Screenshots

Landing Page:

Home Page:

Summary Page:

Flashcards Page:

Contributing

We welcome contributions from the community! If you'd like to contribute to StudyMate, please follow these steps:

1. Fork the Repository: Click the "Fork" button on GitHub to create your copy.

2. Clone Your Fork:

   git clone https://github.com/yourusername/StudyMate.git

3. Create a Branch:

   git checkout -b your-branch-name

4. Make Changes: Implement your changes.

5. Commit Your Changes:

   git commit -m "Description of your changes"

6. Push Your Changes:

   git push -u origin your-branch-name

7. Create a Pull Request: Submit your changes for review.

License

This project is licensed under the MIT License.

Acknowledgments

• Shepherd.js for the interactive guided tour library
• React for the amazing JavaScript library
• Node.js for the robust JavaScript runtime
• Express.js for the minimalist web application framework
• Gemini API for their powerful API integration

---