https://github.com/dom-53/Inkita
Inkita is a lightweight Android reader for Kavita: fast browsing, offline downloads, and reliable progress sync. It caches metadata, pages, and thumbnails so you can read on the go and resume exactly where you left off.
https://github.com/dom-53/Inkita
android android-app epub epub-reader free kavita kotlin-android pdf pdf-reader reader
Last synced: 3 days ago
JSON representation
Inkita is a lightweight Android reader for Kavita: fast browsing, offline downloads, and reliable progress sync. It caches metadata, pages, and thumbnails so you can read on the go and resume exactly where you left off.
- Host: GitHub
- URL: https://github.com/dom-53/Inkita
- Owner: dom-53
- License: apache-2.0
- Created: 2025-12-06T13:02:23.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2026-02-11T13:54:59.000Z (4 months ago)
- Last Synced: 2026-02-11T20:48:21.812Z (4 months ago)
- Topics: android, android-app, epub, epub-reader, free, kavita, kotlin-android, pdf, pdf-reader, reader
- Language: Kotlin
- Homepage:
- Size: 15.4 MB
- Stars: 39
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: docs/security-storage-testing.md
Awesome Lists containing this project
README
# Inkita
Unofficial Android reader for your self-hosted **Kavita** library.
[](https://github.com/dom-53/Inkita/actions/workflows/release.yml)
[//]: # ([](https://github.com/dom-53/Inkita/releases))
[](https://github.com/dom-53/Inkita/releases)
---
## Overview
Inkita is a Kotlin/Jetpack Compose Android app to browse and read from your Kavita server. It aims for fast navigation, a clean reader, and tight API integration (collections, progress, metadata).
**Tech:** Kotlin, Jetpack Compose (Material 3), Retrofit/OkHttp, WorkManager, Room/DataStore.
**Formats:** EPUB (primary); other formats planned.
**Status:** Preview (0.x); APIs and UI may change.
---
## Features
- Browse libraries, collections, tags, genres with filters.
- Series detail with covers, metadata, tags, related items, specials.
- Reader with progress sync, offline mode, downloaded page handling, “delete after reading” depth.
- Downloads: queue, per-volume/page downloads; foreground notifications via a shared manager.
- Network-aware: connectivity monitor, offline toggle, WorkManager constraints.
- Update check: fetches `updates.json` (preview/stable channels) and can download a new APK.
---
## Download
- **Preview** (alpha/beta): universal APKs are published in [Releases](https://github.com/dom-53/Inkita/releases).
- **Update feed:** `https://dom-53.github.io/Inkita/updates.json` (app uses it for update checks).
- **Stable:** not published yet (0.x).
---
## Connecting to your Kavita server
Inkita ships without any preset server configuration. After the first launch:
1. Open **Settings → Kavita**.
2. Fill in your server URL credentials and your Kavita API key.
3. Save the configuration and restart app; the app will then authenticate and sync your libraries.
Without these details the app cannot reach your server, so make sure to keep them up to date (especially when rotating API keys).
---
## Getting Started (dev)
1. **Prereqs:** Android Studio Giraffe+, JDK 17.
2. **Configure Kavita:** In-app settings → set server URL and API key.
3. **Run:** `./gradlew assembleDebug` or launch from Android Studio (preview/release buildTypes available).
> Requires your own Kavita server; no content is bundled.
---
## Contributing
Contributions are welcome (bugfixes, UX polish, docs). Please:
- Keep changes Compose-friendly and minimal.
- Align with Kavita API contracts.
- Add concise comments only where needed.
- Before opening an issue, check if it already exists.
- Before opening a PR, run `./gradlew detekt spotlessApply`.
## Help Translate
- Contribute translations on [POEditor](https://poeditor.com/join/project/XLBygoGhOX)
## Logs / Debug
- You can export or save anonymized logs from **Settings → Advanced → Logs**; saved zips are written to `Documents/Inkita/logs`.
- Sensitive data (host/IP/API key) is anonymized in log files and exports.
- For bug reports: enable **Verbose logging**, reproduce the issue, then attach the exported ZIP to your issue/report.
---
## Support
If you find Inkita useful, you can support development on Ko-fi: https://ko-fi.com/dom53
---
## Disclaimer
Inkita is an unofficial community project, not affiliated with the Kavita team. Use at your own risk; APIs and behavior may change in 0.x releases.
---
## Note from the author
This is my first Android app in Kotlin; parts of the code may not be perfectly optimized yet. I’m steadily improving and refactoring to get it into the best shape possible. Thanks for your patience and feedback!
