Skip to content

Latest commit

 

History

History
142 lines (96 loc) · 4.11 KB

README.md

File metadata and controls

142 lines (96 loc) · 4.11 KB

CODEJAM V5

Basic Idea

A Chrome Extension that processes all classroom content and classifies it into lectures, assignments, and announcements sections. It also allows users to add tags for classification and filtering based on lecture difficulty and exams (T1, T2, T3). Additionally, a chatbot feature is included, which can summarize content, clear doubts, and assist with lecture-related queries. User will also be able to save notes regarding some lectures if they want to.

Tech Stack

  • React: Frontend components
  • Tailwind CSS: Styling
  • Vite: Build tools and configuration
  • Express and Node.js: Backend
  • MongoDB Atlas: Database
  • AWS S3 Bucket: For storing lectures
  • Pinecone: Vector Database to store context of documents.
  • Gemini: gemini-pro-1.5 model as our ai assistant.

Expected Frontend Screens

  • Sign-Up and Login Screen
  • Home Screen
  • Lecture Screen
  • Chatbot Screen
  • Notes Screen

Expected Backend Functionality

  • Authentication Routes: Login and Sign-Up
  • User Information Routes:
    • Processed classroom information
    • Saved chats
  • Chatbot Functionality: Provide streamed responses using Gemini.
  • Notes Functionality: CRUD on Notes for each lectures.
  • Handle Lecture Upload: recieve and upload lectures to S3 and save details to database.

Expected Content Script Work

  • Scrap the classroom course data: Scrap the links of the lectures and send it to the server
  • Simple UI: UI Button and status to inform user of processing.

Features

Features Implemented

  • Signup/Login completed end to end.
  • Able to process the lectures links from the classroom, download them and save them to s3 bucket through server, and store the lectures and course details in the database.
  • Implemented UI components for chatbot and lectures classification Screens.
  • Chatbot implemented, has the context of previous chats and also the lecture uploaded.

Demo Video

https://www.youtube.com/watch?v=7GPsZ_CkOFE

Future Scope

  • Add further multiple document support for photos, videos and other file extension.
  • Notes and can be shared through a link.
  • Rewriting responses and better chatbot UI.

Basic Architecure and data flow

image

PPT Link

https://docs.google.com/presentation/d/1AdDuOMd7-pPmUYV8chKWzC8zThQCFjqh/edit?usp=sharing&ouid=109962653644267782719&rtpof=true&sd=true

Steps to Run the Project

1. Clone the Repository

Run the following command in your terminal to clone the repository locally:

git clone https://github.com/HarshSharma20503/CodeJam-v5.git

Now navigate to the project using the following command:

cd CodeJam-v5

2. Set Up the Backend

  1. Navigate to the backend directory:

    cd backend && npm install

  2. Create a .env file in the backend directory:

    touch .env

  3. Copy the contents of the .env.example file into .env.

  4. Set up a MongoDB server and obtain the Mongo_URI. Paste the URI into the .env file.

  5. Ensure the .env file contains the valid credentials.

  6. Start the backend server:

    npm run dev

3. Set Up the Frontend

  1. Open a new terminal and navigate to the frontend directory:

    cd frontend

  2. Build the frontend to create the dist folder:

    npm install && npm run build

4. Add the Extension to the Browser

  1. Open your browser and navigate to the extensions page:
    • For Chrome: chrome://extensions
    • For Brave: brave://extensions
  2. Enable Developer Mode (usually found in the top right corner).
  3. Click on Load Unpacked.
  4. Select the dist folder generated in the frontend directory.
  5. The extension is now added and ready to use.

5. Using the Extension

  1. Sign up with an email that uses the @mail.jiit.ac.in domain.
  2. Log in and start using the extension features.

Notes

  • Ensure backend server is running.
  • The backend runs on port 8000 by default. Ensure there are no conflicts.
  • For troubleshooting, ensure MongoDB is running and accessible.