Mobile App
Beta Software
The mobile app is currently beta software. It is fairly developed and provides an overall good experience, but there will be some rough edges and missing features here and there.
As such, these sections of the documentation are subject to change as the app is developed, and may not always be up-to-date.
The Stump mobile app is a cross-platform application built using React Native and Expo.
Core Features
The mobile app is a bit more trimmed down in scope compared to the built-in web app, at least with respect to management features. The app aims to provide a more focused experience, being tailored for on-the-go, mobile use cases. Here are some highlighted features available today:
- Multi-server configurations, so you can connect to multiple Stump instances
- OPDS support, so you can use the app with other OPDS-compatible services
- Basic readers for all supported book formats (e.g., CBZ/CBR, EPUB, PDF, etc.)
- A built-in file browser similar to the web app
- Downloads and offline reading, so you don't need an active internet connection
- Bidirectional sync between offline and online reading (progression, highlights, bookmarks, etc.)
- A "Stump-free" experience that only shows OPDS catalogs if you prefer to not use a Stump server
- Rich reading features, such as bookmarks, annotations, customizable color themes, and more
Planned Features
There are many features planned for the mobile app, including but not limited to:
- Customizable tap zones
- Per-annotation highlight color customization
- Full feature support for major non-management Stump features
- iOS/Android widget support
The app will follow the server as certain large-scale features are added, such as book clubs, journaling, etc.
Getting the App
The app is currently available for beta testing on both iOS and Android.
If you're using an iOS device, you can join the TestFlight to download the app. While you may be able to download the app for macOS (it seems to run the iPadOS version), please note that it is not officially tested at this time.
If you're using an Android device, you can access the open beta on the Google Play Store.
Please remember that the app is a beta release, so there will be bugs and missing features. Your feedback is greatly appreciated!
Contributing
There is no official project or roadmap, but I'm happy to discuss the current state of the app and what needs to be done. Feel free to open an issue/discussion on GitHub or reach out on Discord.
To see actual developer guides, refer to the app README.