NoteKar Android

The Official Native Android Application for NoteKar. Instant tap timestamp logger. Zero friction. 100% Offline-First & Privacy-Focused.

---

Important

🚀 Official Release Hub for NoteKar

This repository is the official home for all new NoteKar version releases, Android APK downloads, and active app development.

📥 To download the latest stable Android APK release, visit: GitHub Releases Page.

🌐 Website/PWA Notekar Repo Github.

---

📖 Table of Contents

• 📸 Screenshots / UI Preview
• 🎯 Features & Highlights
• 🛠️ Tech Stack
• 🌐 Community Translations
• 🔒 Privacy & Legal Policy
• ☕ Support
• 🚀 Version Release Scheme
• 🔮 Upcoming Development Roadmap
• 🤖 F-Droid & Reproducible Build Compliance
• 📦 Project Structure
• 🛠️ Building & Running Locally
• 🔑 Building Release APKs & Keystore Setup
• 📄 License & Attribution

---

📸 Screenshots / UI Preview

Designed for speed, simplicity, and privacy. Every screen is optimized for quick timestamp logging with minimal interaction.

Welcome	Premium	Permissions	Home	History
Quick onboarding and setup.	Premium features at a glance.	Configure permissions for reminders.	Log timestamps with a single tap.	Browse and manage saved entries.

Settings	Privacy	Help	Statistics	Reminders
Customize app preferences.	Privacy, security, and diagnostics.	Guides, FAQs, and legal information.	View activity insights and trends.	Schedule daily and inactivity reminders.

---

🎯 Features & Highlights

• Instant Tap Logging: Tap anywhere on the main screen to log exact timestamps instantly.
• Dual Operating Modes: Switch seamlessly between Two-Way mode (IN/OUT session pairs for work/study) and Single mode (one-shot timestamp logging).
• Rich Local Storage: Fast, persistent local storage powered by Hive & SharedPreferences.
• Android OS Auto-Backup Support: Supports standard Android system auto-backup (Google Drive system backup), ensuring your data can be restored when switching Android devices.
• Transparent & Minimal Permissions:
  • INTERNET: Exclusively used to check for software releases and fetch bug fix announcements.
  • POST_NOTIFICATIONS: Used locally for update alerts and timestamp reminders.
• Zero Backend / Zero Analytics: No cloud databases, no user accounts, no tracking scripts, no third-party ads.
• Data Control & Export: Export all timestamp entries into standard CSV or JSON formats at any time.

---

🛠️ Tech Stack

NoteKar is built using modern, performance-oriented technologies:

Component	Technology
Language	Dart
Framework	Flutter (SDK 3.12.0+)
Local Database	Hive (NoSQL, lightning-fast key-value store)
State Management	Provider
Architecture	Clean Architecture
UI & Design	Custom Apple-inspired design system with AMOLED dark mode support.
Platform Support	Android 5.0 (API 21+) and above

---

🌐 Community Translations

Help make NoteKar available in your native language! We welcome translation contributions for any language.

• 📖 Read the Translation Guide (TRANSLATIONS.md) for a simple 3-step walkthrough on creating or updating .arb files.

---

🔒 Privacy & Legal Policy

NoteKar Android is built with privacy-by-design. Your logs, notes, and session history remain stored locally on your device.

• 🛡️ Privacy Policy: Full privacy policy detailing data handling, local storage, and permissions.
• 📜 Terms of Use: Terms of service and open-source usage.
• 🌐 NoteKar Web PWA: Official Web application & legal hub.

---

☕ Support

If NoteKar helps you, you can support the project here:

Your support helps keep NoteKar free, offline-first, and actively maintained.

🚀 Version Release Scheme

NoteKar uses shortcodes in version tags to differentiate build stability:

• BR (Beta Release): Early access, pre-release builds featuring experimental UI changes and active feature development.
• SR (Security Release): Critical maintenance updates, library upgrades, security patches, and hotfixes.
• SB (Stable Build): Production-ready public builds that have passed thorough quality assurance and stability tests.

---

🔮 Upcoming Development Roadmap

We are planning to build the following features in upcoming updates:

• Sobriety (Relapse / Nofap) Streaks & Day Counter:
  • Dynamic Streak Widget: Dynamic day counter card with milestone awards and streak progress tracks.
  • Relapse Trigger Log: Privacy-focused triggers diary to analyze mood, location, or time patterns offline.
  • AMOLED Lockscreen Overlay: Fast checking from home widgets to keep the user accountable without opening the app.

---

🤖 F-Droid & Reproducible Build Compliance

NoteKar Android meets all official F-Droid inclusion requirements:

• 100% Open Source: Code licensed under the OSI-approved MIT License.
• No Proprietary Dependencies: Zero Google Play Services, Firebase SDKs, or closed-source libraries.
• No Trackers: Zero telemetry scripts or analytics frameworks.
• Fastlane Metadata: Fully structured in fastlane/metadata/android/en-US/.

---

📦 Project Structure

Notekar - Flutter/
├── android/                # Android native project files & Gradle build scripts
├── assets/                 # App fonts (Inter) and icon resources
├── fastlane/               # F-Droid Fastlane metadata & graphics
│   └── metadata/android/en-US/
├── lib/
│   ├── main.dart           # App entry point, Hive DB init, and theme setup
│   ├── dialogs/            # Settings, confirmation & note dialogs
│   ├── models/             # Data models for timestamp entries
│   ├── screens/            # Home screen & history views
│   ├── utils/              # Database wrappers & helper functions
│   └── widgets/            # Custom UI components & interactive buttons
├── screenshot/             # GitHub banner graphic (notekar_banner.png)
├── CHANGELOG.md            # Version release history
├── CONTRIBUTING.md         # Developer contribution guidelines
├── CODE_OF_CONDUCT.md      # Community Code of Conduct
├── SECURITY.md            # Security policy & vulnerability reporting
├── PRIVACY_POLICY.md       # Privacy policy reference
├── TERMS.md                # Terms of use reference
├── pubspec.yaml            # Project dependencies & asset configuration
├── README.md               # App documentation
├── LICENSE                 # MIT License
└── .github/                # Funding & GitHub Issue/PR templates

---

🛠️ Building & Running Locally

Prerequisites

1. Install Flutter SDK (^3.12.0 or higher).
2. Install Android Studio with Android SDK (API 21+).
3. Connect an Android device (via USB Debugging or Wireless Debugging) or start an Android Emulator.

Setup Steps

1. Clone the Android repository:

   git clone https://github.com/dheeraz101/Notekar-Android.git
   cd Notekar-Android

2. Fetch Flutter packages:

   flutter pub get

3. Run on connected device:

   flutter run

---

🔑 Building Release APKs & Keystore Setup

Important

Signing secrets and keystores (*.jks, key.properties) are ignored by Git to ensure repository safety.

To build a signed release APK or App Bundle (.aab):

1. Generate a keystore (if you don't already have one):

   keytool -genkey -v -keystore android/app/upload-keystore.jks -keyalg RSA -keysize 2048 -validity 10000 -alias upload

2. Create android/key.properties in your local copy:

   storePassword=<your-store-password>
   keyPassword=<your-key-password>
   keyAlias=upload
   storeFile=upload-keystore.jks

3. Build Release APK:

   flutter build apk --release

   The APK will be generated at build/app/outputs/flutter-apk/app-release.apk.

---

📄 License & Attribution

• License: Open source under the MIT License.
• Initiative: Part of the YABP (Yet Another Boring Project) initiative.
• Developer: Dheeraz
• Made with ❤ in India.