polar. documentation

technical reference and user guide for polar. v1.6.2

overview

polar. is an offline-first android task manager built with kotlin. it follows clean architecture + mvvm and stores everything locally using room.

the app targets android 7.0+ (api 24) and is compiled with the latest android sdk. it intentionally does not request the internet permission.

key features

  • โœ“ tasks with title, description, due date, priority, estimated time and recurrence
  • โœ“ unlimited subtasks with checkbox completion
  • โœ“ custom lists with icon, color and drag & drop ordering
  • โœ“ tag-based filtering with #tag syntax
  • โœ“ monthly calendar with dot indicators and daily agenda
  • โœ“ date, time and location-based reminders
  • โœ“ statistics with bar, line and donut charts
  • โœ“ 7 themes, 6 fonts, 2 checkbox styles and font size slider
  • โœ“ launcher widget for today's tasks
  • โœ“ local backup and restore in json, plus csv import

architecture

the app uses a single activity with manual fragmentmanager navigation. ui is built with xml layouts and view binding.

dependency injection is handled by hilt. background work uses kotlin coroutines and workmanager for recurring tasks.

core stack

kotlin 2.0.21
room 2.6.1 with sqlite wal
hilt 2.51.1
workmanager 2.9.0
material components 1.13.0

permissions

polar. does not declare the internet permission. it only requests the minimum permissions required for alarms, notifications and optional location reminders.

permission purpose
POST_NOTIFICATIONS post reminders and task notifications
SCHEDULE_EXACT_ALARM trigger exact reminder alarms
ACCESS_FINE_LOCATION optional: location-based reminders
RECEIVE_BOOT_COMPLETED reschedule alarms after device reboot

backup & restore

you can export your entire database to a json file from settings. the file can be imported later on the same or a new device.

csv import is also supported for migrating simple task lists from spreadsheets.

frequently asked questions

is polar. really free?

yes. polar. is free, open source and published under the mit license. there are no ads or in-app purchases.

does it sync with the cloud?

no. polar. is designed to be offline-first. your data never leaves the device unless you manually export a backup.

can i use it on ios?

currently polar. is only available for android. there is no ios version planned at this time.

how do i report a bug?

open an issue on the github repository with steps to reproduce and your android version.