📚 StudyPlan — Turn Chaos into Clarity

⚡ Paste anything. Get a structured study plan instantly.
No manual entry. No missed deadlines.

🌍 Live App: https://studyplan-jvgd.onrender.com/

---

🧠 The Idea

Students don’t lack information.
They lack organization.

Assignments live in:

• 📧 Emails
• 💬 WhatsApp groups
• 📄 PDFs & portals

And the biggest problem?

❌ You have to manually re-enter everything into a planner

---

💡 Solution

StudyPlan removes manual planning completely.

Just:

1. Paste messy text
2. AI extracts tasks
3. Everything becomes structured

🎯 From chaos → clean plan in seconds

---

⚙️ How It Works

User Paste
↓
AI Extraction (Gemini)
↓
Structured Tasks (Dates, Subjects)
↓
User Review + Edit
↓
Planner + Calendar Update

---

✨ Features

🤖 AI Intelligence

• Smart extraction from unstructured text
• Detects deadlines, subjects, tasks, notes
• Handles ambiguous dates with user confirmation

📊 Smart Planning System

• Auto-categorized boards:
  • Due Soon
  • This Week
  • Completed
• Conflict detection (deadline clustering alerts)

📅 Interactive Calendar

• Global calendar view
• Click a date → filter tasks instantly
• Color-coded deadlines

🧩 Seamless Editing

• Inline editing (no popups)
• Modify extracted data before saving

🔔 Smart Notifications

• Modern, glassmorphic toast notifications
• Interactive confirmation modals
• Zero-dependency Vanilla JS implementation
• Automatically adapts to Light/Dark mode

💾 Persistent Storage

• SQLite-based local database
• Structured task + subject mapping

---

🧠 System Architecture

Frontend (Vanilla JS UI)
↓
Node.js Express API
↓
AI Layer (Gemini API)
↓
SQLite Database
↓
State Management + UI Sync

---

🛠 Tech Stack

Layer	Technology
Frontend	HTML, CSS (Glassmorphism), Vanilla JS
Backend	Node.js + Express
Database	SQLite
AI	Google Gemini (GenAI SDK)

---

🚀 Key Differentiators

Feature	StudyPlan	Typical Planners
AI Extraction	✅	❌
Zero Manual Entry	✅	❌
Conflict Detection	✅	❌
Inline Editing	✅	❌

---

📦 Installation

git clone https://github.com/Charushi06/StudyPlan.git
cd StudyPlan
npm install

---

🐳 Docker Development

StudyPlan runs as a single container because Express serves both the API and static frontend, and SQLite is file-based (not a separate database server). Docker provides a consistent, reproducible environment for onboarding and local development.

Prerequisites

• Docker Engine 24+ and Docker Compose v2 (docker compose CLI)
• Copy .env.example to .env and set GEMINI_API_KEY (optional — the app falls back to local NLP without it)

Quick Start

cp .env.example .env   # edit GEMINI_API_KEY
docker compose up --build

Open → http://localhost:3000

Common Docker Commands

Command	Purpose
docker compose up --build	Build and start the stack
docker compose up -d	Start detached
docker compose down	Stop and remove containers (volume preserved)
docker compose down -v	Stop and delete SQLite data
docker compose logs -f app	Tail app logs
docker compose exec app npm test	Run tests inside container
docker compose ps	Show service health status

Development Workflow

• Docker (recommended for onboarding): one command, consistent Node 20 + sqlite3 build, persistent data in the sqlite_data volume
• Local npm (faster iteration): use the bare-metal flow below — no Docker required for day-to-day UI changes
• Reset database: docker compose down -v then docker compose up --build

---

🔑 Environment Setup

Create .env:

GEMINI_API_KEY=your_gen_ai_key_here

---

▶️ Run Locally

Without Docker:

node server.js

Open → http://localhost:3000

---

Project Structure

 StudyPlan
├──  css
│   └──  index.css           # Contains all styling rules, variables, and animations
├──  js
│   ├──  utils
│   │   ├──  aiMock.js       # The original mock UI extraction hook (deprecated)
│   │   ├──  api.js          # The live fetch logic communicating with our Express API
│   │   └──  toast.js        # Modern toast & confirmation modal system
│   ├──  app.js              # The main controller (handles DOM UI, event bindings, and Calendar)
│   └──  store.js            # The Custom State Manager handling our frontend Pub/Sub state
├──  .env.example            # Template file for setting the GEMINI_API_KEY
├──  .dockerignore           # Files excluded from Docker build context
├──  Dockerfile              # Container image for the app
├──  docker-compose.yaml     # Orchestrates the local Docker development stack
├──  .gitignore              # Tells git to ignore databases, environments, and node packages
├──  database.js             # Initializes the SQLite database and executes DB table schemas
├──  index.html              # The frontend structural entry point
├──  package.json            # Node project configuration and backend dependencies
├──  README.md               # The comprehensive project documentation
├──  server.js               # The primary Node.js & Express REST Backend logic
└──  studyplan.db

---

🔮 Future Roadmap

• 🤖 Smarter AI parsing (multi-language)
• 📊 Study analytics dashboard
• 🔔 Smart reminders & notifications
• 📱 Mobile version
• 🧠 AI study assistant
• 🤝 Contributing

---

Want to improve StudyPlan? 🚀

🔥 High-impact contributions:

• Improve AI parsing accuracy
• Add calendar enhancements
• UI/UX upgrades
• Notification system

Steps:

git checkout -b feature/your-feature
git commit -m "feat: add feature"
git push origin feature/your-feature

Open a PR with:

• Clear description
• Screenshots (if UI changes)

---

🐛 Issues

Found a bug? Open an issue!

---

💡 Why This Project?

Because planning should not feel like work.

It should feel like:

• ⚡ Instant
• 🧠 Intelligent
• 🎯 Effortless

---

⭐ Support

If you like this project: 👉 Star ⭐ the repo 👉 Share it

---

📄 License

MIT License

---

⚡ Author

Charushi GitHub: https://github.com/Charushi06

---

GSSoC 2026

---

Built with AI, code, and a mission to simplify student life.

---