Skip to content

NasiChan/syllabus-sync

Repository files navigation

Syllabus Sync 📚✨

Syllabus Sync is an intelligent academic dashboard powered by Google's Gemini 2.5 Flash AI. It automatically analyzes course syllabuses (PDFs or Images) to extract schedules, grading policies, and instructor details, transforming static documents into an interactive, organized study planner.

Syllabus Sync Hero

🚀 Features

  • AI Extraction: Instantly parses syllabus files to find Course Codes, Exams, Quizzes, Assignments, and Grading Breakdowns.
  • Interactive Calendar: A soft, pastel-themed monthly calendar view with expandable event details.
  • Smart Agenda: Filterable event list categorized by course code. Add, edit, or delete events manually.
  • Professor Insights: AI-generated summaries of teaching styles and difficulty ratings (fetched via Google Search grounding).
  • Study Planner: Automatically generates study sessions leading up to major exams based on your time preferences.
  • ICS Export: Download your schedule to sync with Google Calendar, Outlook, or Apple Calendar.
  • Dark Mode: Fully supported dark theme using the "Lassonde" color palette.

🛠️ Tech Stack

  • Frontend: React 19, TypeScript
  • Styling: Tailwind CSS (Custom Pastel & Neumorphic Theme)
  • AI Model: Google Gemini 2.5 Flash (@google/genai)
  • Icons: Lucide React
  • Date Handling: date-fns

⚙️ Setup & Installation

  1. Clone the repository

    git clone https://github.com/yourusername/syllabus-sync.git
    cd syllabus-sync
  2. Install dependencies

    npm install
  3. Configure API Key

    • Get a Gemini API Key from Google AI Studio.
    • Create a .env file in the root directory:
      API_KEY=your_gemini_api_key_here
    • Note: In this web container environment, the API key is injected via process.env.API_KEY.
  4. Run the application

    npm start

📖 Usage Guide

  1. Upload: Drag and drop your course syllabus (PDF or Image) onto the upload card.
  2. Review: The AI will extract all dates and grading rules.
  3. Calendar: Click on days to see events. Click on an event pill to expand details.
  4. Agenda: Use the sidebar/bottom section to view a list of all upcoming tasks. Filter by specific Course Code using the dropdown.
  5. Edit: Click the pencil icon on any event to modify details or add missing events manually.
  6. Insights: Go to the "Grading" tab and click a professor's name to see their rating and summary.
  7. Study: Click the "Sparkles" icon on an Exam/Quiz to generate a study plan.

🎨 Design System

The app uses a custom "Lassonde" color palette with soft pastel variations:

  • Primary: Lassonde Red (#CC3333), Teal (#339999), Plum (#993366)
  • Dark Mode: Deep Midnight Black (#000000) and Navy (#003366)
  • Style: Rounded corners (rounded-3xl), soft shadows, and neumorphic touches.

Powered by Google Gemini

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors