# Incido > **Your notes. Your device. Your terms.** Incido is a privacy-first, on-device note-taking application for Android. All data stays on your device by default — no accounts, no cloud, no trackers. This repository contains the **v0.1 Minimum Viable Product**: a single-user, offline note app demonstrating the core architecture, data layer, and Compose UI shell that future versions will build on. **Current release:** v0.1.1 (patch — see [Changelog](#changelog) below). --- ## Features (v0.1) ### v0.1.1 additions - **Editor respects the soft keyboard.** With edge-to-edge enabled, the editor's `Scaffold` now unions `WindowInsets.systemBars` with `WindowInsets.ime`, so the text field automatically shrinks above the keyboard instead of being hidden behind it. `adjustResize` is also set on `MainActivity` as a pre-Android-15 fallback. - **List cards now show a title + body preview.** The first non-empty line of a note is treated as its title and rendered in a larger / bolder style; the remainder is shown as an abbreviated preview below it (max 2 lines, ellipsised). Empty notes display as "Untitled". ### v0.1.0 (original MVP) - Create, edit, and delete plain-text notes - All notes persisted locally with [ObjectBox](https://objectbox.io/) - Material 3 UI with dynamic color (Android 12+) and dark/light themes - Fully offline — no `INTERNET` permission required - Multi-module Kotlin Multiplatform project (Android today, iOS/Desktop-ready for tomorrow) ## Roadmap See `Incido Development Plan.txt` at the repository root for the canonical roadmap, including on-device ML, cross-platform ports, end-to-end sync, and security features. --- ## License Incido is released under the **GNU Affero General Public License v3.0** (AGPL-3.0). See [`LICENSE`](./LICENSE) for the full text and [`NOTICE`](./NOTICE) for attributions. Any user who runs a modified version as a network service must publish their source code changes. This is intentional — it preserves the "contribute back" guarantee for all downstream users. --- ## Project Layout ``` incido/ ├── app/ # Android entry point (manifest, MainActivity) ├── composeApp/ # Shared Compose UI (KMP commonMain + androidMain) ├── core/ │ ├── domain/ # Pure-Kotlin domain models & repository interfaces │ └── data/ # ObjectBox-backed repository implementation ├── gradle/ # Version catalog (libs.versions.toml) ├── settings.gradle.kts └── build.gradle.kts ``` --- ## Build Instructions ### Prerequisites | Tool | Version | Notes | |------|---------|-------| | JDK | 17 (LTS) | `java -version` | | Android SDK | API 35 + build-tools 35.0.0 | Install via `sdkmanager` | | Gradle | 8.10.2 | Wrapped — `./gradlew` downloads it on first run | | Kotlin | 2.0.21 | Bundled with the Gradle build | You do **not** need Android Studio. The CLI build works. ### 1. Configure `local.properties` Create `local.properties` at the project root (already gitignored): ``` sdk.dir=/path/to/your/Android/sdk ``` On Linux this is typically `~/Android/sdk`. ### 2. Accept SDK licenses (one-time) ```bash yes | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --licenses ``` ### 3. Build the debug APK ```bash ./gradlew assembleDebug ``` The APK is written to `app/build/outputs/apk/debug/app-debug.apk`. ### 4. Install on a device ```bash adb install -r app/build/outputs/apk/debug/app-debug.apk ``` Or open the project in Android Studio and click **Run**. --- ## Manual Smoke Test (from the Development Plan §7.2) ``` [ ] Launch app — see empty state message ("No notes yet. Tap + to start.") [ ] Tap FAB — editor opens, cursor in text field [ ] Type "Test note 1" — tap save — returns to list, "Test note 1" card visible [ ] Repeat for "Test note 2" and "Test note 3" [ ] Confirm all 3 notes visible on the list, newest at top [ ] Tap "Test note 2" card — editor opens with existing content [ ] Change to "Test note 2 (edited)" — tap save [ ] Confirm updated text appears on the card on the list [ ] Long-press "Test note 3" — delete option appears [ ] Confirm delete — note removed from the list [ ] Force-stop app from system settings [ ] Reopen app — "Test note 1" and "Test note 2 (edited)" both visible on the list ``` --- ## Architecture (brief) - **UI**: 100% Jetpack Compose / Compose Multiplatform in `composeApp/`. ViewModels expose immutable `StateFlow` per screen; no third-party state management library. - **Domain**: Pure Kotlin interfaces in `core/domain/` — the only thing the UI sees. - **Data**: `core/data/` provides the ObjectBox implementation. ViewModels depend on the interface, so the data layer can be swapped (e.g., for tests) without touching UI code. ## Contributing Issues and PRs are welcome on the Gitea mirror. AGPL-3.0 means any contributions you submit must be under a compatible license. By submitting a contribution, you affirm you have the right to do so under these terms.