Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pool-of-tears/myne
An android app to download & read ebooks from Project Gutenberg, built with Jetpack Compose.
https://github.com/pool-of-tears/myne
android android-app books ebook-downloader ebook-reader epub-reader fdroid gutenberg-ebooks jetpack-android jetpack-compose kotlin-android kotlin-coroutines material-design material-ui mvvm-architecture ui-design
Last synced: about 1 month ago
JSON representation
An android app to download & read ebooks from Project Gutenberg, built with Jetpack Compose.
- Host: GitHub
- URL: https://github.com/pool-of-tears/myne
- Owner: Pool-Of-Tears
- License: apache-2.0
- Created: 2022-11-21T08:21:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-10T09:35:45.000Z (about 1 month ago)
- Last Synced: 2024-10-15T16:01:03.449Z (about 1 month ago)
- Topics: android, android-app, books, ebook-downloader, ebook-reader, epub-reader, fdroid, gutenberg-ebooks, jetpack-android, jetpack-compose, kotlin-android, kotlin-coroutines, material-design, material-ui, mvvm-architecture, ui-design
- Language: Kotlin
- Homepage: https://pooloftears.in
- Size: 12.3 MB
- Stars: 1,102
- Watchers: 9
- Forks: 62
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Myne: Download & Read eBooks
------
**Myne** is a [FOSS](https://en.m.wikipedia.org/wiki/Free_and_open-source_software) Android application for downloading and reading ebooks from [Project Gutenberg](https://gutenberg.org). It uses the [GutenDex](https://github.com/garethbjohnson/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](https://myanimelist.net/anime/39468/Honzuki_no_Gekokujou__Shisho_ni_Naru_Tame_ni_wa_Shudan_wo_Erandeiraremasen)*.
>[!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](https://m3.material.io/) 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](https://www.androidpolice.com/everything-we-love-about-material-you/amp/) 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](https://github.com/sponsors/starry-shivam) on Github | Purchase it on [Google Play](https://play.google.com/store/apps/details?id=com.starry.myne)
------
Contributions
Contributions are welcome!
>[!Note]
>
>For submitting bug reports, feature requests, questions, or any other ideas to improve, please read [CONTRIBUTING.md](/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](https://developers.helpshift.com/android/i18n/) for Android.
------
Tech Stack
- [Kotlin](https://kotlinlang.org/) - First class and official programming language for Android development.
- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) - To improve performance by doing I/O tasks out of main thread asynchronously.
- [Flow](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/) - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
- [Android Architecture Components](https://developer.android.com/topic/libraries/architecture) - Collection of libraries that help you design robust, testable, and maintainable apps.
- [Jetpack Compose](https://developer.android.com/jetpack/compose?gclsrc=ds&gclsrc=ds) - Jetpack Compose is Android’s recommended modern toolkit for building native UI
- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - Data objects that notify views when the underlying database changes.
- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Stores UI-related data that isn't destroyed on UI changes.
- [OkHttp3](https://square.github.io/okhttp/) - OkHttp is an HTTP client for Android that’s efficient by default.
- [Kotlinx.serialization](https://kotlinlang.org/docs/serialization.html) - Provides sets of libraries for various serialization formats – JSON, CBOR, protocol buffers, and others.
- [Jsoup](https://jsoup.org) - 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](https://coil-kt.github.io/coil/compose/) - An image loading library for Android backed by Kotlin Coroutines.
- [Dagger-Hilt](https://dagger.dev/hilt/) For [Dependency injection (DI)](https://developer.android.com/training/dependency-injection)
- [Room database](https://developer.android.com/jetpack/androidx/releases/room) - Persistence library provides an abstraction layer over SQLite to allow for more robust database access while harnessing the full power of SQLite.
- [Lottie](https://airbnb.design/lottie) - Lottie is an Android, iOS and React Native library that renders After Effects animations in real time.
------
Star History
[](https://star-history.com/#Pool-Of-Tears/Myne&Timeline)
------
License
[Apache License 2.0][license] © [Stɑrry Shivɑm][github]
[license]: /LICENSE
[github]: https://github.com/starry-shivam
```
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.
```