Skip to content
harshini-yuvaraj01Public

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

StudyFlow — Responsive Student Productivity & Study Planner Platform

StudyFlow is a production-quality, responsive web application designed for students to organize tasks, track focus sessions with an interactive Pomodoro timer, discover curated learning resources, and monitor overall study metrics.


🚀 Key Features

  1. Home Page: Hero banner with SVG illustration, interactive statistics counters, key feature cards, testimonials, and responsive navigation.
  2. Productivity Dashboard: Real-time aggregate statistics fetched from MySQL (Total Tasks, Completed Tasks, Pending Tasks, Study Sessions, Hours Studied, Productivity Completion Rate %, and recent activity log).
  3. Study Planner (Task CRUD):
    • Full task management: Create, Read, Update, Delete tasks.
    • Live status toggling (Pending ↔ Completed with visual strikethrough & card styling).
    • Real-time searching by title or subject.
    • Filter by status (All/Pending/Completed) and priority (Low/Medium/High).
    • Sort by deadline, priority rank, or creation date.
  4. Focus Zone (Pomodoro Timer):
    • Work (25 min), Short Break (5 min), and Long Break (15 min) countdown timer with SVG circular progress ring.
    • Start, Pause, Resume, and Reset controls.
    • Web Audio API chime sound alerts upon completion.
    • Automatic logging of finished focus sessions directly to MySQL database.
  5. Learning Resources:
    • Curated topic catalog covering Python, Java, HTML/CSS, JavaScript, Database Systems, and Data Structures & Algorithms.
    • Difficulty level badges (Beginner, Intermediate, Advanced) and direct topic documentation links.
  6. Daily Motivation:
    • Quotes generator with smooth fade transitions, category tags, and copy-to-clipboard functionality.
  7. Contact Page:
    • Contact form with real-time client-side regex email & length validation, remaining character counter, server-side validation, and MySQL persistence.
  8. Design System & UX:
    • Light/Dark theme toggle with localStorage persistence.
    • Glassmorphism backdrop filters, soft shadows, rounded borders, micro-interactions, and mobile slide-in drawer menu.

🛠️ Technology Stack

  • Frontend: HTML5 (Semantic), Vanilla CSS3 (Custom Variables, Flexbox/Grid, Keyframe Animations), Vanilla JavaScript (ES6 Modules, Fetch API, DOM API). No external JS frameworks/libraries.
  • Backend: Python 3 (Flask), flask-cors, pymysql database driver.
  • Database: MySQL 8.x (database/studyflow.sql and database/sample_data.sql). Fallback SQLite driver included for instant zero-config testing.

📁 Project Directory Structure

StudyFlow/
├── frontend/
│   ├── index.html              # Home Page
│   ├── dashboard.html          # Productivity Dashboard
│   ├── planner.html            # Study Task Manager
│   ├── focus.html              # Pomodoro Focus Zone
│   ├── motivation.html         # Daily Motivation Quotes
│   ├── contact.html            # Validated Contact Form
│   ├── css/
│   │   └── style.css           # Core Design System, Themes & Responsiveness
│   └── js/
│       ├── main.js             # Theme toggle, mobile drawer, toasts
│       ├── dashboard.js        # Dashboard statistics loader
│       ├── planner.js          # Full CRUD Task Manager engine
│       ├── focus.js            # Pomodoro timer & audio chime engine
│       ├── motivation.js       # Quotes rotation engine
│       └── contact.js          # Contact form validator & API submission
├── backend/
│   ├── app.py                  # Flask entrypoint & static route handler
│   ├── config.py               # Database and server settings
│   ├── db.py                   # MySQL / Database connection abstraction
│   ├── routes/
│   │   ├── tasks.py            # REST CRUD Endpoints for Tasks (/api/tasks)
│   │   ├── sessions.py         # REST Endpoints for Sessions & Stats (/api/sessions)
│   │   └── contact.py          # REST Endpoints for Contact Messages (/api/contact)
│   └── requirements.txt        # Python dependencies
├── database/
│   ├── studyflow.sql           # MySQL database schema definition
│   └── sample_data.sql         # Seed data script
├── README.md
├── .gitignore
└── LICENSE

⚙️ Installation & Setup Instructions

1. Database Setup (MySQL)

Run the database scripts in your MySQL shell or Workbench:

SOURCE database/studyflow.sql;
SOURCE database/sample_data.sql;

2. Backend Setup (Flask)

Navigate to the backend/ directory and install dependencies:

cd backend
pip install -r requirements.txt

Set environment variables if connecting to a custom MySQL server:

export MYSQL_HOST=localhost
export MYSQL_USER=root
export MYSQL_PASSWORD=root
export MYSQL_DB=studyflow

Run the backend server:

python app.py

The API server will launch at http://127.0.0.1:5000 and automatically serve the frontend!

3. Open Application

Open your browser and navigate to:

http://127.0.0.1:5000/

📌 Suggested Git Workflow

git init
git add .
git commit -m "feat: initial project structure & database schema setup"
git commit -m "feat(backend): implement Flask REST API endpoints for tasks, sessions, resources, and contact"
git commit -m "style(frontend): design modern responsive UI system with dark/light mode and glassmorphism"
git commit -m "feat(frontend): implement full CRUD planner, focus zone pomodoro timer, and live dashboard"

📄 License

Distributed under the MIT License. See LICENSE for details.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages