Mind-o-Mat-App Logo

Mind-o-Mat-App

Native Android client for Mind-o-Mat with German voice capture, system Share Target, vault-independent server settings, and Second-Brain notes explorer.

🇬🇧 English · 🇩🇪 Deutsch


Overview

Mind-o-Mat-App is a native Kotlin & Jetpack Compose Android application built as the mobile companion for Mind-o-Mat. It is 100% vault-independent: no vault path or server secret is hardcoded into the app. Any user can configure their own Mind-o-Mat server URL and optional API Bearer token directly in the app settings to capture voice/text notes on the go, share links or snippets from any Android app, browse existing vault notes, and trigger Git synchronization.


Features

  • Quick Capture (CaptureScreen):
    • Large microphone button powered by Android's native SpeechRecognizer configured for German (de-DE).
    • Markdown and free-text editor with optional title and tags (e.g., #idee, #meeting).
    • Selectable target folder (00_Inbox, 01_Daily, 10_Wiki, 20_Projekte).
    • Per-capture toggles for automatic AI wiki ingestion (autoIngest) and immediate Git push (autoSync).
  • System Quick Share Target (Intent.ACTION_SEND):
    • Registered in AndroidManifest.xml for text/plain intents so text and URLs from any Android app (such as Chrome) can be shared directly into Mind-o-Mat's capture screen.
  • Second Brain Notes Explorer (NotesScreen & NoteDetailScreen):
    • Search across all vault notes via GET /api/notes.
    • Filter by category (Alle, Inbox, Wiki, Daily, Projekte).
    • Note cards displaying preview snippets, tags, and color-coded folder badges.
    • Formatted Markdown detail view (GET /api/notes/{id}).
    • 1-click Git sync button in the top bar (POST /api/sync).
  • Vault-Independent Settings (SettingsScreen):
    • Configurable server URL (default https://mindomat.orfel.de or any custom HTTPS domain/local IP).
    • Optional Bearer API token (Authorization: Bearer <token>).
    • Built-in "Verbindung testen" (Test Connection) action calling GET /api/status.
    • Persistent defaults for autoIngest, autoSync, and defaultFolder.

How It Works & Tech Stack

Component Technology Details
Language & UI Kotlin + Jetpack Compose Material 3 (androidx.compose:compose-bom:2024.10.00), Material Icons Extended
Navigation Jetpack Navigation Compose 2.8.3 Bottom navigation bar (capture, notes, settings) + note_detail/{noteId}
Networking OkHttp 4.12.0 + org.json Communicates with Mind-o-Mat REST API (/api/status, /api/notes, /api/notes/{id}, /api/capture, /api/sync)
Speech Recognition android.speech.SpeechRecognizer German speech-to-text (de-DE) with RECORD_AUDIO runtime permission handling
Storage Android SharedPreferences Stores server URL, API token, and capture defaults locally under mindomat_prefs
Build System Gradle 8.14.3, Java 17 compileSdk 35, targetSdk 35, minSdk 26, applicationId "de.orfel.mindomat"

Prerequisites & Installation

Prerequisites

  • Android Studio (or Android SDK with API 35 / Build-Tools)
  • Java JDK 17
  • Running Mind-o-Mat server (server.mjs / Docker container) reachable via HTTPS or local network (usesCleartextTraffic="true" is enabled for local setups)

Clone & Build Locally

git clone https://git.orfel.de/Jannik/Mind-o-Mat-App.git
cd Mind-o-Mat-App

Build debug or release binaries using the Gradle Wrapper:

# Build release APK
.\gradlew.bat assembleRelease

# Build Google Play Store Android App Bundle (.aab)
.\gradlew.bat bundleRelease

On Linux/macOS, use ./gradlew assembleRelease and ./gradlew bundleRelease.

Signing, Keystore & Output Artifacts

  • Package ID (applicationId): de.orfel.mindomat
  • Keystore: mindomat-upload-key.keystore (checked into the repository; do not delete or change its alias/password)
  • Key Alias: mindomat-alias
  • Upload Certificate: upload_certificate.pem
  • SHA-256 Fingerprint: 55:7C:14:4A:E9:AC:A7:78:97:78:7A:09:3C:A9:27:48:F7:D8:E8:91:3B:36:29:06:41:20:80:45:A7:EF:5D:82

Release outputs are written to app/build/outputs/ and archived in apks/ using the versioned naming scheme defined in AGENTS.md:

  • apks/Mindomat_v23.01.X.apk (direct sideloading / installation)
  • apks/Mindomat_v23.01.X.aab (Google Play Console release bundle)

When bumping a release in app/build.gradle, keep versionName ("23.01.X") and versionCode (X) synchronized (e.g., 23.01.1 → versionCode 1).


Configuration

Build Signing Credentials

app/build.gradle reads release signing passwords from local.properties (not committed) or environment variables:

Key / Env Variable Description
RELEASE_STORE_PASSWORD Password for mindomat-upload-key.keystore
RELEASE_KEY_PASSWORD Password for key alias mindomat-alias

Never commit real passwords or local.properties secrets to Git.

In-App Settings

Setting Default Description
Server-URL https://mindomat.orfel.de Base URL of your Mind-o-Mat server (trailing slash trimmed automatically)
API-Token (empty) Optional HMAC Bearer token (NOTES_API_TOKEN output from npm run token-gen)
Standardmäßig KI-Ingest true Automatically trigger LLM wiki ingestion on /api/capture
Standardmäßig Git-Push true Automatically trigger mindomat sync on /api/capture
Standard-Ordner 00_Inbox Default target directory for new notes

Usage

  1. Install apks/Mindomat_v23.01.X.apk on your Android device (or deploy .aab via Google Play Console).
  2. Open the Einstellungen (Settings) tab, enter your Mind-o-Mat server URL and (if enabled on the server) your API Bearer token, tap Verbindung testen, and save.
  3. Use Capture to dictate notes in German via the microphone button or type Markdown directly, assign tags and a target folder, and submit (POST /api/capture).
  4. From any other Android app (e.g., Chrome), tap Share → Mind-o-Mat to pre-fill the Capture screen with the shared text or URL.
  5. Open Notizen to search, filter by folder, read formatted Markdown notes, or trigger a manual Git sync via the header sync button.

Project Structure

Mind-o-Mat-App/
├── apks/
│   ├── Mindomat_v23.01.1.aab
│   └── Mindomat_v23.01.1.apk
├── app/
│   ├── build.gradle                              # Android config, SDK 35, Compose & OkHttp deps
│   ├── debug.keystore
│   └── src/main/
│       ├── AndroidManifest.xml                   # Permissions & ACTION_SEND share intent filter
│       ├── java/de/jannik/mindomat/
│       │   ├── MainActivity.kt                   # Navigation, bottom bar, permission & share handling
│       │   ├── data/
│       │   │   ├── ApiClient.kt                  # OkHttp REST client for Mind-o-Mat server
│       │   │   ├── Models.kt                     # Data models (Capture, Notes, Status)
│       │   │   └── SettingsRepository.kt         # SharedPreferences wrapper (mindomat_prefs)
│       │   ├── speech/
│       │   │   └── SpeechManager.kt              # German Android SpeechRecognizer wrapper
│       │   └── ui/
│       │       ├── screens/
│       │       │   ├── CaptureScreen.kt          # Voice & Markdown quick-capture UI
│       │       │   ├── NotesScreen.kt            # Vault explorer with search & folder filters
│       │       │   ├── NoteDetailScreen.kt       # Formatted Markdown note reader
│       │       │   └── SettingsScreen.kt         # Server URL, token & connection test UI
│       │       └── theme/
│       │           ├── Color.kt
│       │           └── Theme.kt
│       └── res/                                  # Launcher icons, strings, XML backup rules
├── assets/
│   └── logo.png
├── gradle/wrapper/
├── AGENTS.md                                     # Versioning, naming & keystore rules
├── build.gradle / settings.gradle / gradle.properties
├── mindomat-upload-key.keystore                  # Release upload keystore
├── upload_certificate.pem                        # Upload public certificate
├── README.md
└── LIESMICH.md

License

This project's own code and configuration are dedicated to the public domain under CC0 1.0 Universal — see LICENSE.

External dependencies installed via package managers or Docker images retain their respective open-source licenses.

S
Description
Native Android-Companion-App für Mind-o-Mat mit deutscher Spracherkennung, Quick-Share-Capture und Git-Sync.
Readme CC0-1.0
86 MiB
0 Stars 1 Watchers 0 Forks
Languages
Kotlin 100%