Skip to content

SudhirDevOps1/The-Ultimate-Master-Study-Tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ FlowTrack Pro: The Ultimate Master Study Tracker

The professional-grade, strict productivity ecosystem built for relentless learners.


๐ŸŒŸ Executive Summary

FlowTrack Pro is not just a timer; it is a full-scale study ecosystem. Built to solve the problems of digital distraction, it combines high-precision engineering with gamified psychology. It is designed for students, developers, and researchers who need a tool that is as serious about their time as they are.


๐Ÿ’Ž Premium Design Philosophy

FlowTrack and its "Pro" iterations are built on three core pillars of modern software design:

1. Minimalist Immersive UI

  • Glassmorphism: Subtle translucency and blurred background elements create a sense of depth without distraction.
  • Dynamic Theming: Six curated professional themes (Ocean, Forest, Sunset, Galaxy, Neon, Cyber) to match your mood and focus level.
  • Framer Motion Integration: Every transition is mathematically smoothed to ensure the UI feels "alive" and premium.

2. The "Strict Focus" Engine

Most trackers fail because they rely on simple browser timers. FlowTrack Pro uses a Delta-Sync Logic:

  • It tracks the exact millisecond you started.
  • It calculates elapsed time against the system hardware clock.
  • It is resilient to browser crashes, tab sleeps, and OS-level battery saving.

3. Privacy-First Sovereignty

In an era of data harvesting, FlowTrack Pro is a fortress.

  • No Cloud Required: 100% of your data stays in your browser's IndexedDB.
  • Zero Tracking: No telemetry, no ads, no external cookies.
  • Local Ownership: You own your database. Export it, back it up, or clear it whenever you want.

๐Ÿ”ฅ Master Feature Breakdown

โฒ๏ธ Ultra-Precision Timer System

The heart of the application.

  • System-Level Accuracy: Derived from Date.now() timestamps, not JS intervals.
  • Auto-Pause Awareness: Detects visibility changes and pauses instantly when the tab is hidden to prevent "cheating".
  • Resilient Recovery: Automatically picks up exactly where it left off after a refresh or crash.

๐Ÿ“บ Advanced Picture-in-Picture (Floating Timer)

Study over any app.

  • Always-on-Top: Using the Document PiP API, it floats above VS Code, PDF Readers, and YouTube.
  • Mini-Controller: Control music, skip tracks, and monitor progress without leaving your study app.
  • Real-Time Heartbeat: Keeps the browser process active even when minimized.
  • Interaction passthrough: Mouse movements over the mini-timer reset the idle countdown.

๐ŸŽฎ Gamification & The XP Economy

Turning focus into progress.

  • XP Calculation: Fixed rate of 1 XP/Minute, ensuring fair progress tracking.
  • Leveling Curve: A custom logarithmic formula (Math.floor(Math.sqrt(totalXP / 10))) that makes early levels fast and late levels prestigious.
  • The "Rank" System: Progress through titles:
    • ๐ŸŒฑ Novice Seeker (Level 1-5)
    • ๐Ÿ“– Focused Scholar (Level 6-15)
    • ๐Ÿง  Master Learner (Level 16-30)
    • ๐Ÿ‘‘ Flow Sovereign (Level 31+)
  • Streak Heatmap: A 90-day GitHub-style contribution map to visualize your consistency.

๐Ÿ“Š Professional Analytics Suite

  • Granular Filtering: Filter sessions by subject, completion status, or date ranges.
  • Visual Trends: Multi-axis Recharts displaying Daily, Weekly, Monthly, and Yearly performance.
  • Subject Mastery: Pie charts and bar graphs showing which subjects you are dominating.
  • Planned vs. Performance: Automatic calculation of "Goal Attachment" (did you study as much as you planned?).

๐ŸŽง Immersive Ambience & Soundscapes

  • Focus LO-FI: Built-in streaming focus music.
  • Curated Environmental Audio:
    • ๐ŸŒง๏ธ Heavy Rain: For deep, isolated focus.
    • โ˜• Paris Cafe: For background hum and creative work.
    • ๐ŸŒฒ Ancient Forest: For calm, anxiety-free study.
    • ๐Ÿ’จ White Noise: For pure concentration.
  • Layered Controls: Independent volume sliders for music and ambient sounds.

๐Ÿ—๏ธ Technical Architecture & Developer Map

๐Ÿ“ Detailed Directory Map

FlowTrack-Pro/
โ”œโ”€โ”€ .gemini/                # Configuration for advanced AI assistance
โ”œโ”€โ”€ public/                 # Static Assets
โ”‚   โ”œโ”€โ”€ manifest.json       # PWA transformation settings
โ”‚   โ”œโ”€โ”€ sw.js               # Service Worker core logic (Caching & Offline)
โ”‚   โ””โ”€โ”€ icons/              # Multi-resolution branding assets
โ”œโ”€โ”€ src/                    # The Engine Room
โ”‚   โ”œโ”€โ”€ components/         # Modular UI Components
โ”‚   โ”‚   โ”œโ”€โ”€ charts/         # Analytics layer (Recharts implementation)
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ ActivityHeatmap.tsx
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ SubjectChart.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ common/         # Foundation components
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Button.tsx
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Panel.tsx   # The "Glass" container base
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Modal.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ layout/         # High-level architecture
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Navbar.tsx
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ TabNavigation.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ session/        # Business logic for session management
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ SessionForm.tsx
โ”‚   โ”‚   โ””โ”€โ”€ timer/          # Core timer functionality
โ”‚   โ”‚       โ”œโ”€โ”€ FloatingTimer.tsx # PiP Implementation
โ”‚   โ”‚       โ”œโ”€โ”€ TimerDisplay.tsx
โ”‚   โ”‚       โ””โ”€โ”€ AmbiencePlayer.tsx
โ”‚   โ”œโ”€โ”€ hooks/              # Custom Logic Containers
โ”‚   โ”‚   โ””โ”€โ”€ useTimer.ts     # The "Brain" of the time tracking system
โ”‚   โ”œโ”€โ”€ lib/                # Third-party integrations
โ”‚   โ”‚   โ””โ”€โ”€ db.ts           # Dexie/IndexedDB configuration
โ”‚   โ”œโ”€โ”€ pages/              # View layer
โ”‚   โ”‚   โ”œโ”€โ”€ TimerPage.tsx
โ”‚   โ”‚   โ”œโ”€โ”€ AnalyticsPage.tsx
โ”‚   โ”‚   โ””โ”€โ”€ HistoryPage.tsx
โ”‚   โ”œโ”€โ”€ store/              # Global State Management
โ”‚   โ”‚   โ””โ”€โ”€ useAppStore.ts  # Master State (Zustand)
โ”‚   โ”œโ”€โ”€ types/              # TypeScript Contract layer
โ”‚   โ”‚   โ””โ”€โ”€ models.ts       # Global interfaces (StudySession, Subject, etc.)
โ”‚   โ””โ”€โ”€ utils/              # Pure utility functions
โ”‚       โ”œโ”€โ”€ time.ts         # Formatting & Math
โ”‚       โ””โ”€โ”€ xp.ts           # Leveling logic
โ”œโ”€โ”€ artifacts/              # Development history & Roadmap
โ”œโ”€โ”€ package.json            # Dependency manifest
โ”œโ”€โ”€ vite.config.ts          # Build system configuration
โ””โ”€โ”€ README.md               # The Master Document

๐Ÿง  Deep Logic Implementations

1. The Delta-Timer Algorithm

Instead of trusting setInterval (which is inconsistent in browsers), we use:

elapsed = isPaused ? savedElapsed : (Date.now() - startedAtMs)

This ensures that even if the browser stops the JS execution for 5 minutes to save battery, when it wakes up, the math remains 100% correct.

2. IndexedDB Synchronization

Using Dexie.js, we implement a "Transactional Sync":

  • Every 1 second of active study, the activeSession is updated in the database.
  • This creates a "Checkpointed Save" system.
  • If the user's laptop dies, they only ever lose a maximum of 1 second of data.

3. The PWA "Offline-First" Strategy

  • Service Worker: Cache-first strategy for static assets.
  • Manifest: Allows the "Install App" button in Chrome/Edge, making it look and feel like a native Windows/Mac app.
  • Offline Analytics: Since Recharts and calculation logic are local, graphs work perfectly even in airplane mode.

๐Ÿ› ๏ธ Technology Specification


๐Ÿš€ Deployment & Setup

๐Ÿ’ป Automatic Desktop Launcher (Windows - Recommended)

If you want to run FlowTrack with local activity tracking (foreground window / tab usage tracking):

  1. Simply double-click start_local.bat.
  2. This batch script will automatically:
    • Verify Python is installed and create a .venv virtual environment if it doesn't exist.
    • Install required dependencies (pywin32, psutil).
    • Run the background activity tracker on http://localhost:5001.
    • Install Node package dependencies (npm install).
    • Start the Vite server and open FlowTrack in your browser.

๐ŸŒ Manual Developer Setup

  1. Install Node.js dependencies:
    npm install
  2. Start the Web app developer server:
    npm run dev
  3. Start the Python activity tracker (optional):
    python activity_tracker.py

๐Ÿง  Local AI & Ollama Integration

To use the AI Assistant fully offline and private with Ollama:

  1. Install Ollama.
  2. Configure CORS so the browser-based FlowTrack client is allowed to connect to Ollama:
    • Windows CMD:
      set OLLAMA_ORIGINS=*
      ollama serve
    • Windows PowerShell:
      $env:OLLAMA_ORIGINS="*"
      ollama serve
    • macOS/Linux:
      OLLAMA_ORIGINS="*" ollama serve
  3. Open FlowTrack, navigate to AI Assistant > Settings (Gear Icon), select Ollama, click Auto-Detect Models, and save configuration.

๐Ÿ“ Usage & Strict Design Guidelines

  • Backup Naming: Whenever you export your workspace data from the Settings page, FlowTrack generates the filename dynamically based on the current date, e.g., 15-06-2026.json.
  • Cheat Prevention: Actual time for timed sessions is locked in the editor. Only manual session logs can have their studied time directly edited.
  • Strict Inactivity auto-pause: If Strict Focus Mode is enabled and a session is running, the timer will automatically pause and trigger a system notification after 10 minutes of zero active mouse movement, touchpad interactions, keyboard inputs, or scroll/touch activity.
  • Floating Timer: Click Open Floating Timer to launch a persistent window widget on top of all other windows (e.g. while studying offline PDFs or coding).

๐Ÿ“œ Version Credits & Info

  • FlowTrack Pro v2.2.0
  • Engineered by Sudhir Singh for the Global Student Community.
  • Privacy Policy: 100% Local. AI API keys are stored securely in your browser's IndexedDB and are never shared or uploaded.

About

FlowTrack Pro: The Ultimate Master Study Tracker The professional-grade, strict productivity ecosystem built for relentless learners.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages