{"id":15027596,"url":"https://github.com/folioreader/folioreader-android","last_synced_at":"2025-05-14T19:09:54.327Z","repository":{"id":30006660,"uuid":"33554674","full_name":"FolioReader/FolioReader-Android","owner":"FolioReader","description":"A Java ePub reader and parser framework for Android.","archived":false,"fork":false,"pushed_at":"2023-10-10T13:26:47.000Z","size":107452,"stargazers_count":2296,"open_issues_count":271,"forks_count":728,"subscribers_count":81,"default_branch":"master","last_synced_at":"2025-05-14T19:09:46.147Z","etag":null,"topics":["android","custom-fonts","epub","epub-reader","highlight","java","night-mode"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FolioReader.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"License.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-04-07T16:25:03.000Z","updated_at":"2025-05-10T11:48:43.000Z","dependencies_parsed_at":"2023-01-14T16:15:18.301Z","dependency_job_id":"59e166bc-6a41-41c6-9dec-c2e84d4f202e","html_url":"https://github.com/FolioReader/FolioReader-Android","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FolioReader%2FFolioReader-Android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FolioReader%2FFolioReader-Android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FolioReader%2FFolioReader-Android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FolioReader%2FFolioReader-Android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FolioReader","download_url":"https://codeload.github.com/FolioReader/FolioReader-Android/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254209859,"owners_count":22032897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","custom-fonts","epub","epub-reader","highlight","java","night-mode"],"created_at":"2024-09-24T20:06:44.920Z","updated_at":"2025-05-14T19:09:46.556Z","avatar_url":"https://github.com/FolioReader.png","language":"JavaScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=5%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=10%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=15%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=25%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=50%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=100%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted"],"categories":[],"sub_categories":[],"readme":"![FolioReader logo](https://raw.githubusercontent.com/FolioReader/FolioReaderKit/assets/folioreader.png)\n\n[![Build Status](https://api.travis-ci.org/FolioReader/FolioReader-Android.svg?branch=master)](https://travis-ci.org/FolioReader/FolioReader-Android)\n\nFolioReader-Android is an EPUB reader written in Java and Kotlin.\n\n### Features\n\n- [x] Custom Fonts\n- [x] Custom Text Size\n- [x] Themes / Day mode / Night mode\n- [x] Text Highlighting\n- [x] List / Edit / Delete Highlights\n- [x] Handle Internal and External Links\n- [x] Portrait / Landscape\n- [ ] Reading Time Left / Pages left\n- [x] In-App Dictionary\n- [ ] Media Overlays (Sync text rendering with audio playback)\n- [ ] TTS - Text to Speech Support\n- [ ] Parse epub cover image\n- [ ] PDF support\n- [x] Book Search\n- [x] Add Notes to a Highlight\n- [ ] Better Documentation\n- [x] Last Read Locator\n- [x] Horizontal Reading\n- [x] Distraction Free Reading\n\n## Demo\n##### Custom Fonts\n![Custom fonts](https://cloud.githubusercontent.com/assets/1277242/19012915/0661c7b2-87e0-11e6-81d6-8c71051e1074.gif)\n##### Day and Night Mode\n![Day night mode](https://cloud.githubusercontent.com/assets/1277242/19012914/f42059c4-87df-11e6-97f8-29e61a79e8aa.gif)\n##### Text Highlighting\n![Highlight](https://cloud.githubusercontent.com/assets/1277242/19012904/c2700c3a-87df-11e6-97ed-507765b3ddf0.gif)\n##### Media Overlays\n![Media Overlay](https://cloud.githubusercontent.com/assets/1277242/19012908/d61f3ce2-87df-11e6-8652-d72b6a1ad9a3.gif)\n\n### Gradle\n\nAdd following dependency to your root project `build.gradle` file:\n\n```groovy\nallprojects {\n    repositories {\n        ...\n        jcenter()\n        maven { url \"https://jitpack.io\" }\n        ...\n    }\n}\n```\n\nAdd following dependency to your app module `build.gradle` file:\n\n```groovy\ndependencies {\n    ...\n    implementation \"com.folioreader:folioreader:0.5.4\"\n    ...\n}\n```\n\n### Enable Multidex support\n\nEnable Multidex support as explained in this [Android Doc](https://developer.android.com/studio/build/multidex)\n\n### Usage\n\nGet singleton object of `FolioReader`:\n\n```java\nFolioReader folioReader = FolioReader.get();\n```\n\nCall the function `openBook()`:\n\n##### opening book from assets -\n\n```java\nfolioReader.openBook(\"file:///android_asset/TheSilverChair.epub\");\n```\n##### opening book from raw -\n\n```java\nfolioReader.openBook(R.raw.accessible_epub_3);\n```\n\n\n## WIKI\n\n* [Home](https://github.com/FolioReader/FolioReader-Android/wiki)\n* [Configuration](https://github.com/FolioReader/FolioReader-Android/wiki/Configuration)\n    * [Custom Configuration](https://github.com/FolioReader/FolioReader-Android/wiki/Custom-Configuration)\n* [Highlight](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight)\n    * [Highlight Action](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight-Action)\n    * [Highlight Event](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight-Event)\n    * [Providing External Highlight](https://github.com/FolioReader/FolioReader-Android/wiki/Providing-External-Highlight)\n* [ReadLocator](https://github.com/FolioReader/FolioReader-Android/wiki/ReadLocator)\n* [Clean up code](https://github.com/FolioReader/FolioReader-Android/wiki/Clean-up-code)\n\n## Reporting Issue\n\nSee [KNOWN_ISSUES](https://github.com/FolioReader/FolioReader-Android/blob/master/KNOWN_ISSUES.md) and [CHANGELOG](https://github.com/FolioReader/FolioReader-Android/blob/master/CHANGELOG.md) first before reporting any issue. \u003cbr /\u003e\nPlease follow [Issue Template](https://github.com/FolioReader/FolioReader-Android/blob/master/.github/ISSUE_TEMPLATE.md) to report any issue.\n\n## Share your application\nIf you are using FolioReader in your application, share your application link in [this issue](https://github.com/FolioReader/FolioReader-Android/issues/291)\n\n### Credits\n1. \u003ca href=\"https://github.com/daimajia/AndroidSwipeLayout\"\u003eSwipeLayout\u003c/a\u003e\n2. \u003ca href=\"https://github.com/readium/r2-streamer-kotlin\"\u003er2-streamer-kotlin\u003c/a\u003e\n3. \u003ca href=\"http://developer.pearson.com/apis/dictionaries\"\u003ePearson Dictionaries\u003c/a\u003e\n4. \u003ca href=\"https://github.com/timdown/rangy\"\u003erangy\u003c/a\u003e\n\n### Author\n[**Heberti Almeida**](https://github.com/hebertialmeida)\n\n- Follow me on **Twitter**: [**@hebertialmeida**](https://twitter.com/hebertialmeida)\n- Contact me on **LinkedIn**: [**hebertialmeida**](http://linkedin.com/in/hebertialmeida)\n\n[**CodeToArt Technology**](https://github.com/codetoart)\n\n- Follow us on **Twitter**: [**@codetoart**](https://twitter.com/codetoart)\n- Contact us on **Website**: [**codetoart**](http://www.codetoart.com)\n\n## Donations\n\n**This project needs you!** If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, **feel free to donate**. Your donation is highly appreciated. Thank you!\n\n**PayPal**\n\n - [**Donate 5 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=5%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): Thank's for creating this project, here's a tea (or some juice) for you!\n - [**Donate 10 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=10%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): Wow, I am stunned. Let me take you to the movies!\n - [**Donate 15 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=15%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): I really appreciate your work, let's grab some lunch! \n - [**Donate 25 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=25%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): That's some awesome stuff you did right there, dinner is on me!\n - [**Donate 50 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=50%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): I really really want to support this project, great job!\n - [**Donate 100 $**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026amount=100%2e00\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted): You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!\n - Of course, you can also [**choose what you want to donate**](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=hebertialmeida%40gmail%2ecom\u0026lc=US\u0026item_name=FolioReader%20Libraries\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted), all donations are awesome!\n\n## License\nFolioReaderKit is available under the BSD license. See the [LICENSE](https://github.com/FolioReader/FolioReader-Android/blob/master/License.md) file.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolioreader%2Ffolioreader-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffolioreader%2Ffolioreader-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolioreader%2Ffolioreader-android/lists"}