StudySync

A comprehensive Study Management System for academic productivity

Overview

StudySync is a comprehensive Study Management System built with modern Java technologies. It combines Spring Boot's robust backend capabilities with JavaFX's rich desktop UI and H2 embedded database for reliable data persistence. The application helps students organize their academic life effectively with integrated task management, study tracking, and project management capabilities.

Perfect for students who want to integrate their academic calendar with task management and study tracking! 📚✨

⚠️ Beta Release: This is version 0.1.6 under active development. Features may change, and some functionality may be incomplete. Please report issues and provide feedback!

Key Features

StudySync provides comprehensive academic management with three main modules:

📚 Study Planner Features, with Daily Reflections Logging

• Study Sessions: Track study time with built-in timer and focus level monitoring
• Study Goals: Set and manage daily study objectives with future date planning
• Future Goal Planning: Navigate to any future date and plan goals ahead via DatePicker
• Recurring Tasks: Define repeating task schedules (e.g. every week on Mon/Wed/Fri)
• Daily Reflections: Record daily study insights and progress notes
• Progress Tracking: Visual progress indicators and session statistics
• Study Analytics: Monitor completed sessions and goal achievements
• Off Days / Holidays: Mark any calendar day as an off day — it shows as a holiday in the calendar and never counts towards your global scores or breaks your study streak
• Scoring: Points reward time studied scaled by focus, achieved goals, and finishing tasks on time; the same formula drives both the per-day calendar score and your 30-day profile score

📋 Task & Project Management Features

• Task Management: Create, edit, and delete tasks with rich attributes (title, description, category, priority, deadline, status, recurring schedule)
• Recurring Tasks: Mark any task as recurring with a weekly/bi-weekly/monthly pattern and specific day-of-week selection, with a separate "repeat until" date so a recurring task can still have a real deadline
• Project Management: Comprehensive project lifecycle management with session logging and progress tracking
• Category Management: Create and manage custom categories for better organization
• Task Reminders: Choose how many days before a deadline a task starts reminding you; it shows a countdown badge and appears under "Coming up" in the planner
• Data Persistence: All data stored reliably in embedded H2 database

Google Calendar Integration (planned and not implemented as of now)

• OAuth 2.0 Authentication: Secure Google account login
• Today's Events: View all Google Calendar events for the current day
• Real-time Sync: Refresh calendar events with one click
• Seamless Integration: Calendar events displayed alongside study tasks

☁️ Google Drive Sync

• Google Sign-in: Connect your personal Google account directly from the Profile window
• Drive Storage: The embedded H2 database is uploaded to a private StudySync folder inside your Drive
• Multi-device ready: Pull the Drive copy with Download from Drive and it is applied on the next launch; the local database is uploaded whenever the app closes
• Manual Sync: Trigger Sync to Drive now anytime you want an extra backup mid-session
• Purely local: No StudySync backend—OAuth tokens and the H2 file never leave your machine + Google Drive

Installation & Running the Application

Quick Install (Linux)

Both options run the same installer — the difference is whether you start from a pre-built release or compile from source.

Pre-built release (no Gradle required, just Java 21):

curl -LO https://github.com/geokoko/StudySync/releases/latest/download/studysync-linux.tar.gz
curl -LO https://github.com/geokoko/StudySync/releases/latest/download/studysync-linux.tar.gz.sha256
sha256sum -c studysync-linux.tar.gz.sha256
tar -xzf studysync-linux.tar.gz
cd studysync-*-linux
./install.sh

Build from source (requires Gradle):

git clone https://github.com/geokoko/StudySync.git
cd StudySync
./scripts/install.sh --build

After installation:

• Launch from app menu: Search "StudySync" in your application launcher (KDE, GNOME, etc.)
• Launch from terminal: Run studysync

To uninstall: ~/.local/share/studysync/bin/uninstall.sh

Installing a beta: releases/latest resolves to the newest stable release, so the commands above skip pre-releases. To install a specific version, use its tag:

curl -LO https://github.com/geokoko/StudySync/releases/download/v0.1.6-beta/studysync-linux.tar.gz
curl -LO https://github.com/geokoko/StudySync/releases/download/v0.1.6-beta/studysync-linux.tar.gz.sha256

Tip: studysync-linux.tar.gz is a stable alias attached to every release. Versioned files (studysync-<version>-linux.tar.gz) are also attached.

---

Running with Gradle (Development)

1. Clone the Repository

   git clone https://github.com/geokoko/StudySync.git
   cd StudySync

2. Configure the application

   cd ./src/main/resources
   cp application.yml.template application.yml
   # Edit application.yml if needed (optional for basic usage)

3. Run the Application

   • Use the Gradle wrapper (recommended):

     ./gradlew run   # (Linux/macOS)
     gradlew run     # (Windows)

   • Use Gradle if you have it installed: If you have Gradle>=8.5, then run:

     gradle build
     gradle run

     Note: Some dependencies of this application are not compatible with the latest version of Gradle (9.0.0) as of right now.

   Gradle will:

   • Automatically download all dependencies (JavaFX, H2 Database, Spring Boot, etc.)
   • Set up the module path correctly for JavaFX
   • Initialize the H2 embedded database
   • Launch the application (com.studysync.StudySyncApplication)

Additional Run Options

• Fast startup (skip some initialization):

  ./scripts/start-fast.sh

• Build release package (for distribution):

  ./scripts/build-release.sh
  # Creates build/release/studysync-VERSION-linux.tar.gz

Google Drive Sync Setup (Optional)

1. Create Google API credentials
   • Visit Google Cloud Console
   • Enable the Google Drive API for your project
   • Create OAuth client credentials of type Desktop application and note the client ID/secret
2. Provide the credentials to StudySync
   • Copy the template file and fill in the values:

     cp config/google/drive.properties.template config/google/drive.properties
     # edit config/google/drive.properties with your client id/secret

   • You can override the Drive folder name, redirect port, or where credentials are cached as needed
3. Run StudySync and connect your Google account
   • Launch the app, open the Profile → Google Drive Sync panel, and click Sign in with Google
   • Your browser will handle OAuth locally; tokens are stored in ~/.studysync/google
4. Understand the sync flow
   • Downloading is manual: press Download from Drive, then restart. The copy is verified against its checksum and applied before H2 opens, and your previous database is kept under data/backups/
   • When the app closes (or you press Sync to Drive now), the local database is uploaded back to Google Drive
   • StudySync never merges the two sides. If both have changed, pick one — Download from Drive replaces local, Sync to Drive now replaces remote

Setting up a second machine

drive.properties holds your client ID/secret and is not part of the release tarball, which ships only the template. Copy it across yourself:

scp ~/.local/share/studysync/config/google/drive.properties \
    other-machine:~/.local/share/studysync/config/google/

Then, on the new machine: launch StudySync → Profile → Sign in with Google → Download from Drive → restart. Until you download and restart you are looking at an empty database — nothing is fetched automatically. OAuth tokens under ~/.studysync/google are per-machine; sign in again rather than copying them.

The actual database file lives inside My Drive/StudySync/studysync.mv.db. No remote StudySync server is involved—the desktop app talks to Google APIs directly.

Architecture

StudySync uses the Active Record pattern with Spring Boot for a clean, maintainable architecture. See ARCHITECTURE.md for detailed architectural information and code examples.

Data Storage

• Database: H2 embedded database (data/studysync.mv.db)
• Schema Migrations: schema.sql re-runs on every startup, so statements are additive (ALTER TABLE ... ADD COLUMN IF NOT EXISTS) or recompute derived data. The few genuinely one-shot migrations are guarded by a schema_migrations marker table so they cannot re-fire
• Cloud Backup (optional): When Drive sync is enabled, the same file is mirrored to My Drive/StudySync/studysync.mv.db
• Logs: Application logs stored in logs/ directory
• Configuration: YAML configuration files in src/main/resources/
• Security: Encrypted credentials stored locally