v0.3.0.0 bundles four user-facing features, the plan-compliance polish
that was deferred from v0.2, and a permanent change to how we name
releases going forward.
VERSION SCHEME (app/build.gradle.kts)
- versionName = '0.3.0.0' (MAJOR.MINOR.MAINTENANCE.EMERGENCY)
- versionCode = 5
- New gradle taskGraph validator fails the build if versionName
doesn't match ^\d+\.\d+\.\d+\.\d+$ — we can't accidentally
regress the scheme.
- History re-keyed across README, Plan §10, CONTRIBUTING.md.
HASHTAGS
- value class Hashtag (domain/model) with normalise/parseOrNull
helpers; pattern: ^[a-z0-9][a-z0-9._-]{0,30}$
- data class HashtagUsage (name, noteCount, lastUsedAt)
- sealed class NoteFilter { Home, Favorites, Untagged, ByTag(name) }
- Note gains hashtags: List<String> (sorted ascending)
- Repository:
- new entities HashtagEntity (@Index on name) and
NoteHashtagCrossRef (many-to-many junction)
- new methods: observeFavorites / observeUntagged /
observeNotesForHashtag / observeHashtagsByRecentUse /
observeAllHashtags / searchHashtags / addHashtag / removeHashtag
- search() now matches content OR hashtag-name (case-insensitive)
- ObjectBox queries use explicit StringOrder + type annotations
(kapt's stubs are finicky around Property<String> overloads)
UI
- CenterAlignedTopAppBar on both list and editor screens
- List:
- Hamburger top-left opens a ModalNavigationDrawer (Home /
Favorites / Untagged / divider / scrollable Recent tags)
- Drawer selection drives a NoteFilter state held at root
- Search bar visible only when filter == Home
- NoteCard redesign — 14 dp vertical gradient stripe +
tinted surface (12 % colour blend) + 10 dp corner chip
- Empty-state copy is filter-aware
- Editor:
- Persistent hashtag chip row above the text field
- Tag # icon in the top bar + '+ add' chip opens a ModalBottomSheet
- Autocomplete suggestions live from repository.searchHashtags
- '+ Create name' button when the typed value is valid + new
- Snackbar 'Maximum 5 tags reached.' when the cap is hit
- Reconciled on save via addHashtag / removeHashtag diff
DOCS
- README v0.3.0.0 section + re-keyed changelog
- Development Plan §10 history re-keyed (0.1.0.0 / 0.1.1.0 /
0.2.0.0 / 0.2.0.1 / 0.3.0.0)
- CONTRIBUTING.md release-process note updated for the new scheme
VERIFIED
- ./gradlew assembleDebug assembleRelease both green
- Debug 25.7 MB, release 19.8 MB (v2-signed)
- versionCode=5, versionName='0.3.0.0'
- No INTERNET permission
- Validator regression: setting versionName='0.3' causes
assembleDebug to fail with the new scheme error message
265 lines
9.4 KiB
Markdown
265 lines
9.4 KiB
Markdown
# 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.3.0.0** release: a single-user, offline
|
|
note app with hashtags, favourites, full-text search, colour-coded
|
|
notes, and a navigation drawer. The architecture is multi-module Android
|
|
today and is structured so iOS / Desktop ports can happen later without
|
|
UI rewrites.
|
|
|
|
**Current release:** v0.3.0.0 (see [Changelog](#changelog) below).
|
|
|
|
> **Version scheme (from v0.3.0.0 onwards):** `MAJOR.MINOR.MAINTENANCE.EMERGENCY` —
|
|
> e.g. `0.3.0.0`. `MAJOR.MINOR.MAINTENANCE` are normal release numbers;
|
|
> `EMERGENCY` is non-zero only for hotfixes shipped out-of-band.
|
|
> `versionCode` is a monotonic int and always +1 per release.
|
|
> An empty MAINTENANCE/EMERGENCY slot is written as `0`.
|
|
> The build refuses to compile if `versionName` doesn't match this shape.
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
### v0.3.0.0 highlights
|
|
|
|
- **Hashtags.** Tag any note with up to 5 hashtags. Tags are always
|
|
visible as chips above the editor text field; tap ✕ to remove. Tap
|
|
`#` (or `+ add`) to open a sheet with autocomplete suggestions from
|
|
your existing tags. Hashtags are searchable from the list (typing
|
|
`work` finds notes containing the word *and* notes tagged `#work`).
|
|
- **Bolder colour accent on list cards.** Each colour-tagged note now
|
|
gets a 14 dp vertical gradient stripe on the left, a subtle 12 %
|
|
tinted card background, and a 10 dp solid colour chip in the
|
|
top-right — so different-coloured notes are visually distinct at a
|
|
glance without you needing to focus on the stripe.
|
|
- **Navigation drawer.** Hamburger top-left opens a drawer with
|
|
**Home**, **Favorites**, **Untagged**, a divider, then a live scrollable
|
|
list of the most-recently-used hashtags. Tap any entry to filter the
|
|
list to just those notes.
|
|
- **Centred app-bar title.** Both the list screen (`Incido`) and the
|
|
editor (`Edit note` / `New note`) now centre their titles via
|
|
Material 3's `CenterAlignedTopAppBar`.
|
|
- **New version scheme.** All version bumps from now on follow the
|
|
`MAJOR.MINOR.MAINTENANCE.EMERGENCY` pattern; the build refuses anything
|
|
that doesn't match.
|
|
|
|
### v0.2.0.0
|
|
|
|
- **Favourites.** Tap the star icon on any card to pin it to the top of
|
|
the list.
|
|
- **Full-text search.** Tap the search icon in the top app bar; the list
|
|
filters live as you type.
|
|
- **Color-coded notes.** Pick from six preset accent colours in the
|
|
editor; each list card gets a 4 dp vertical stripe.
|
|
- **Inline checklists.** Lines beginning with `- [ ]` or `- [x]` show
|
|
open/done counts on the card preview.
|
|
- **Discard-confirm dialog.** Closing the editor with unsaved changes
|
|
prompts `Discard changes?` (works for both Back arrow and hardware
|
|
back gesture).
|
|
- **Release signing** — dev keystore in `keystore/`, `assembleRelease`
|
|
produces a v2-signed APK out of the box.
|
|
|
|
### v0.2.0.1 (hotfix)
|
|
|
|
- **Search icon actually opens the search bar.** v0.2.0.0's
|
|
search-active flag was on a separate `StateFlow` the composable never
|
|
observed; folded into `uiState` so tapping the icon now lights up the
|
|
field.
|
|
|
|
### v0.1.1.0
|
|
|
|
- **Editor respects the soft keyboard.** `Scaffold` unions
|
|
`WindowInsets.systemBars` with `WindowInsets.ime` so the text field
|
|
shrinks above the keyboard. `adjustResize` set as pre-Android-15
|
|
fallback.
|
|
- **List cards now show a title + body preview.** First non-empty line
|
|
= title; remainder = body preview (max 2 lines, ellipsised).
|
|
Empty notes display as "Untitled".
|
|
|
|
### v0.1.0.0
|
|
|
|
- Create, edit, and delete plain-text notes
|
|
- ObjectBox-backed persistence ([objectbox.io](https://objectbox.io/))
|
|
- Material 3 UI with dynamic color (Android 12+), dark/light follows system
|
|
- Fully offline — no `INTERNET` permission
|
|
- Multi-module Android project (Android today, iOS/Desktop-ready later)
|
|
|
|
---
|
|
|
|
## Roadmap
|
|
|
|
See [`Incido Development Plan.txt`](./Incido%20Development%20Plan.txt) at
|
|
the repository root for the canonical backlog, including on-device ML,
|
|
cross-platform ports, end-to-end sync, and security features.
|
|
|
|
---
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Highlights |
|
|
|-----------|------------|------------|
|
|
| 0.1.0.0 | 2026-08-14 | First MVP: list + editor, ObjectBox, Material 3 |
|
|
| 0.1.1.0 | 2026-08-14 | Editor IME fix + title/body on list cards |
|
|
| 0.2.0.0 | 2026-08-14 | Polish + favourites, search, colours, checklists, discard dialog, release signing |
|
|
| 0.2.0.1 | 2026-08-14 | Hotfix: search icon now actually opens the search bar |
|
|
| 0.3.0.0 | 2026-08-14 | Hashtags (visible chips on editor, 5-tag cap, autocomplete) + bolder colour accent + nav drawer (Home / Favorites / Untagged + recent tags) + centred app-bar title + new version scheme |
|
|
|
|
---
|
|
|
|
## 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 module
|
|
├── core/
|
|
│ ├── domain/ # Pure-Kotlin domain models + repository interface
|
|
│ └── data/ # ObjectBox-backed repository implementation
|
|
├── gradle/ # Version catalog (libs.versions.toml) + wrapper
|
|
├── keystore/ # Release signing (gitignored *.jks, README kept)
|
|
├── .gitea/ # Gitea Actions workflow + issue/PR templates
|
|
├── CONTRIBUTING.md
|
|
├── CODE_OF_CONDUCT.md
|
|
└── LICENSE
|
|
```
|
|
|
|
---
|
|
|
|
## 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. (Optional) Build a signed release APK
|
|
|
|
```bash
|
|
./gradlew assembleRelease
|
|
```
|
|
|
|
Uses the dev keystore at `keystore/release.jks` — see
|
|
[`keystore/README.md`](./keystore/README.md) for regeneration instructions.
|
|
**Replace this keystore with a production key before any external
|
|
distribution.**
|
|
|
|
The build will **fail** if `versionName` doesn't match
|
|
`^\d+\.\d+\.\d+\.\d+$` (the new scheme). Update `app/build.gradle.kts`
|
|
to fix.
|
|
|
|
### 5. 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**.
|
|
|
|
---
|
|
|
|
## Remote / Gitea Setup
|
|
|
|
When your self-hosted Gitea instance is online, register the remote and
|
|
push the existing local commits:
|
|
|
|
```bash
|
|
git remote add origin https://your-gitea.example.com/yourname/incido.git
|
|
git push -u origin main
|
|
git push origin --tags # if you have any local tags
|
|
```
|
|
|
|
After the first push:
|
|
|
|
- `.gitea/workflows/build.yml` will automatically build the debug APK
|
|
on every push to `main` and on every pull request. The APK is uploaded
|
|
as a workflow artefact (`.gitea → Actions → build → Artifacts`).
|
|
- `.gitea/ISSUE_TEMPLATE/bug_report.yml` and
|
|
`feature_request.yml` will be picked up by Gitea when users open new
|
|
issues.
|
|
- `.gitea/PULL_REQUEST_TEMPLATE.md` will be auto-loaded on new PRs.
|
|
|
|
---
|
|
|
|
## Manual Smoke Test (Development Plan §7.2 + v0.3.0.0 additions)
|
|
|
|
```
|
|
[ ] Launch app — "Incido" title centred, hamburger top-left
|
|
[ ] Tap hamburger → drawer slides in with Home / Favorites / Untagged + divider + Recent tags
|
|
[ ] Tap "Favorites" → list shows only starred notes
|
|
[ ] Tap "Untagged" → list shows only notes with zero hashtags
|
|
[ ] Tap a recent hashtag → list filters to that tag
|
|
[ ] Tap "Home" → back to all notes
|
|
[ ] Open a note → chip row above text field shows current tags (empty placeholder if none)
|
|
[ ] Tap "#" icon → sheet opens, type "wo" → suggestions filter
|
|
[ ] Add a new tag → chip appears, counter goes from N/5 to (N+1)/5
|
|
[ ] Tap chip ✕ → removed
|
|
[ ] Add 5 tags, attempt 6th → Snackbar "Maximum 5 tags reached"
|
|
[ ] Force-stop + reopen → all notes + hashtags + favourites + colours persist
|
|
```
|
|
|
|
---
|
|
|
|
## Architecture (brief)
|
|
|
|
- **UI**: 100% Jetpack Compose in `composeApp/`. ViewModels expose
|
|
immutable `StateFlow<UiState>` 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
|
|
|
|
See [`CONTRIBUTING.md`](./CONTRIBUTING.md). All participants are expected
|
|
to follow [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md). By submitting a
|
|
contribution you affirm you have the right to license it under AGPL-3.0.
|