Myne: A Kotlin repository from vikasswebdev

Myne: Download & Read eBooks

Myne is a FOSS Android application for downloading and reading ebooks from Project Gutenberg. It uses the GutenDex API to fetch metadata for ebooks in the backend. Additionally, it functions as an EPUB reader, allowing you to easily import and immerse yourself in your favorite EPUB books!

The name of the app is inspired from the main character of an anime called Ascendance of a Bookworm.

Note

The app also utilizes the Google Books API to retrieve additional data such as synopsis and page count. As the Gutenberg project does not include these values in their metadata. While the app attempts to map the data received from Google Books with Gutenberg's metadata, the mapping is not always 100% accurate. Additionally, not all books available on Gutenberg are accessible on Google Books, or they may be available under different titles. As a result, you may find some books without synopsis or page count, etc.

Screenshots

Highlights

Clean & beautiful UI based on Google's material design three guidelines.
Browse and download over 70k free ebooks available in multiple languages and updated daily.
Comes with inbuilt ebook reader while also having an option to use third-party ebook readers.
Compatible with Android 8.0 and above (API 26+)
Supports Material You theming in devices running on Android 12+
Comes in both light and dark mode.
MAD: UI and logic written with pure Kotlin. Single activity, no fragments, only composable destinations.

Downloads

Donations

Myne doesn't contain any ads and doesn't sell your data. The development of the app is financed by individual user contributions, such as you purchasing the app via Google Play or becoming a sponsor on Github ❤️

Become a Sponser on Github | Purchase it on Google Play

Contributions

Contributions are welcome!

Note

For submitting bug reports, feature requests, questions, or any other ideas to improve, please read CONTRIBUTING.md for instructions and guidelines first.

Translations

If you want to make the app available in your language, you're welcome to create a pull request with your translation file. The base string resources can be found under:

/app/src/main/res/values/strings.xml

It is easiest to make a translation using the Android Studio XML editor, but you can always use your favorite XML text editor instead. Check out this guide to learn more about translation strings from Helpshift for Android.

Tech Stack

Kotlin - First class and official programming language for Android development.
Coroutines - To improve performance by doing I/O tasks out of main thread asynchronously.
Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
- Jetpack Compose - Jetpack Compose is Android’s recommended modern toolkit for building native UI
- LiveData - Data objects that notify views when the underlying database changes.
- ViewModel - Stores UI-related data that isn't destroyed on UI changes.
OkHttp3 - OkHttp is an HTTP client for Android that’s efficient by default.
Kotlinx.serialization - Provides sets of libraries for various serialization formats – JSON, CBOR, protocol buffers, and others.
Jsoup - Jsoup is a Java library for working with HTML. It provides a convenient API for extracting and manipulating data, using the HTML5 DOM methods and CSS selectors.
Coil - An image loading library for Android backed by Kotlin Coroutines.
Dagger-Hilt For Dependency injection (DI)
Room database - Persistence library provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.
Lottie - Lottie is an Android, iOS and React Native library that renders After Effects animations in real time.

Star History

License

Copyright (c) [2022 - Present] Stɑrry Shivɑm

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

vikasswebdev/Myne