Skip to content

ovrrup/Lumia

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

133 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎓 Lumia

Kotlin Android Jetpack Compose SQLite Room GPLv3 License

Build APK Latest Release

Lumia is an offline-first academic battle-station designed for students, self-learners, and those fighting the modern urge of checking notifications every 17 seconds. This application wraps course trackers, attendance calculators, task schedulers, statistical visualization charts, and a zero-compromise focus ecosystem into a single unified terminal.

Powered by a customized True AOD (Always-On Display) study-screen overlay, Lumia turns your phone into a dedicated OLED focus timer. It overrides standard brightness limits, monitors accelerometers for physical movement, and defends your studies against the constant storm of lockscreen distractions.


🏛️ Central Feature Architecture

1. The Dashboard Control Center

Lumia launches straight into your central visual hub:

  • At-a-glance status checks: See your class schedule for the current date, pending coursework tasks, and active deadlines.
  • The Judgmental Streak Flame (🔥): Maintains active streak logs. Keep your studying trend rising; otherwise, the flame dies, and Lumia’s statistics look disappointingly empty.
  • Fast Metrics: Direct displays of average subjects completion indices, remaining files to read, and quick links to continue your last coursework node.

2. Deep Academic Trees (Courses & Subjects)

Track organized courses (e.g., Computer Science (B.Sc.) or Pre-Med) down to the atomic study level:

  • Structurable Entities: Courses split into independent Subjects, which contain nested Chapters, containing tracked Topics and study milestones.
  • Progress Tracking: Interactive completed percentages rise dynamically as you check off topics, helping you study step-by-step.
  • Attendance Registry: Log class attendance records with fully visual percentage charts. No more manually guessing if you can afford to skip that 8:00 AM lecture.

3. Pomodoro Focus Engine & "True AOD"

This isn't a simple aesthetic countdown timer. Lumia features a dual-mode system overlay that blocks standard Android lock-panel updates to turn your phone into a pure hardware focus clock:

  • The True AOD Interface: Shows simple time elements, focus progress rings, dynamic study ticks, and pure black OLED-safe background configurations.
  • Dual Integration Profiles:
    • System Overlay Mode: Draws the study board over active applications and system interfaces for instantaneous access.
    • Accessibility Service Mode: Installs a private accessibility engine that intercepts key handlers to safely lock the interface behind hardware controls under modern lockscreens (Android 12+).
  • OLED Stealth Level: Slide down hardware outputs with dimming levels up to 99% Highest Darkness (perfect for studying in dimly lit library desks).
  • Anti-Cheat Wake-up Sensitivities: Pick how Lumia unlocks:
    • Tap/Motion: Uses linear accelerometer deltas. Simply shake, tilt, or wave your hand above the device to wake up!
    • Double-tap: Prevents accidental triggers inside deep backpack pockets.
    • Hold Secure: Requires holding down on the OLED panel for 1 second to end focus. Excellent for preventing quick exit impulses when trying to focus.

4. Continuous Analytics Terminal

Visualize your scholarly dedication using built-in, native vector bar graphs, charts, and distribution indicators:

  • Subject distribution maps explaining where your hours went.
  • Historical trend indicators showing Pomodoro focus efficiency over time.
  • Attendance ratios complete with Material 3 status tags showing safe vs critical attendance values.

5. Quick Notes Storage

A localized scratchpad to quickly log fleeting research items, ideas, formulas, or coffee orders. Everything stays private, offline, and ready to edit or delete at a moment's notice.

6. Over-The-Air (OTA) Updates & App Internals

  • In-App Updater: Automatically checks for new versions of Lumia on startup by securely fetching metadata from the official GitHub Release channel. You can update straight from the Settings panel.
  • LogDog (The Persistent Canine Diagnostic Agent 🐕): If something breaks under the hood, Lumia integrates an internal crash handler that catches exceptions, formats stack traces, and compiles diagnostic files. View and manage local repair suggestions directly inside the Lumia Settings Panel.

🔒 Privately Local & Factual

Lumia believes that your study logs should never be a telemetry product:

  • Zero Remote Calls: No remote trackers, analytical frameworks, or advertising APIs.
  • Local Databases: SQLite Room database isolated inside highly secure local Android sandboxes.
  • Offline Reliability: Perfect for off-grid reading sessions, cellular-restricted campus basements, or flights. Network access is strictly restricted to occasionally checking for GitHub OTA app updates.

For formal clauses, view our dedicated Privacy Policy and Terms and Conditions.


🛠️ Build & Development Guidelines

Lumia has been heavily polished to utilize modern Android patterns (Jetpack Compose, Kotlin Coroutines, and Room Architecture).

Compilation Checklist

  1. Ensure you have Android Studio Koala or newer installed.
  2. Verify you have JDK 17+ configured on your environmental path.
  3. Keep standard dependencies untouched to ensure version-locked compiler compatibility.

Building via Terminal

To build, test, and package Lumia manually, run standard Gradle execution commands in the root directory:

# Verify unit tests & Robolectric interfaces
gradle :app:testDebugUnitTest

# Build the complete installable development APK
gradle assembleDebug

After compilation, your build artifacts will reside in:
app/build/outputs/apk/debug/app-debug.apk


🚀 Downloading Lumia & Automatic Updates

Lumia comes pre-configured with a continuous integration pipeline.

Setup Automated Releases

Every time you push or trigger a Pull Request to your main / master repository branches:

  1. GitHub Runner launches an Ubuntu container.
  2. Setup-Java configures JDK 17 environments.
  3. Evaluates layout integrity, clean assets, and compiles Lumia.
  4. Saves the compiled application as a downloadable artifact.

How to Install the App

  1. Navigate to the Releases section on the right-hand sidebar of the GitHub repository page (or click Releases).
  2. Under the latest release (e.g., v1.0.2), expand the Assets section if collapsed.
  3. Click on the compiled .apk asset file to download it.
  4. Transfer the downloaded APK file to your Android device and install it! You will receive notification overlays in the app when future updates are released.

⚖️ Open Source & GPLv3 Licensing

This project is licensed under the GNU General Public License v3.0.

You are free to fork, hack, and deploy Lumia according to open-source safety rules. If you release your own modified variant of Lumia to the world, you must keep the source code public and license your modifications under the GPLv3.

Let's maintain software freedom together! Read LICENSE for the full regulatory texts.

About

Yet another study tracker (with some better features ?)

Topics

Resources

License

Stars

6 stars

Watchers

0 watching

Forks

Contributors

Languages