https://github.com/jocmp/capyreader
A smallish Android RSS reader
https://github.com/jocmp/capyreader
android feed-reader feedbin freshrss google-reader miniflux rss rss-feed-reader rss-reader
Last synced: 9 days ago
JSON representation
A smallish Android RSS reader
- Host: GitHub
- URL: https://github.com/jocmp/capyreader
- Owner: jocmp
- License: mit
- Created: 2023-03-06T03:41:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T02:58:28.000Z (11 months ago)
- Last Synced: 2025-03-13T03:29:26.808Z (11 months ago)
- Topics: android, feed-reader, feedbin, freshrss, google-reader, miniflux, rss, rss-feed-reader, rss-reader
- Language: Kotlin
- Homepage: http://capyreader.com/
- Size: 54.2 MB
- Stars: 421
- Watchers: 3
- Forks: 19
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Capy Reader
_A smallish RSS reader with support for Feedbin, FreshRSS, and local feeds._
## Download
- [Google Play][gplay_link]
- [F-Droid][fdroid_link]
- [IzzyOnDroid][izzy_link]
- [GitHub Releases][github_link]
Capy Reader is free across all sources. It is available for devices running Android 11 or later.
### Releases
- Google Play releases happen every week or so depending on new features, bugfixes and translations.
- GitHub releases are marked with a "-dev" suffix and happen more frequently. They are always stable, tested builds.
- Nightly releases are a separate package marked with a "-nightly" suffix. These are unstable, untested builds.
## Reporting a bug
Bug reports are always welcome and are a top priority. Please search the [discussions](https://github.com/jocmp/capyreader/discussions) first and issues to make sure the bug is new and hasn't been reported yet.
If you're in doubt or run into an unreported issue, go ahead and submit a bug report. Please include details like app version, OS version, and steps to reproduce the bug. Screenshots are also useful!
[Report a bug](https://github.com/jocmp/capyreader/discussions/new?category=bugs)
## Feature Requests
If you have questions or a general feature request, please post them to discussions as a [feature request](https://github.com/jocmp/capyreader/discussions/new?category=feature-requests).
### Full Content Support
Sometimes Capy's full content mode doesn't work as expected on a site due to the chaos of the web.
When this happens, please submit a separate issue to support full content for that site: [Full Content Request form](https://github.com/jocmp/capyreader/issues/new?template=2-full-content-request.yml)
Writing and verifying full content parsers can be time consuming. If you find this useful, [consider donating](https://ko-fi.com/capyreader) to show your support.
## Roadmap
Check out the [project roadmap](https://github.com/users/jocmp/projects/3) to see what's currently in progress and on deck.
## Contributing
### Translations
Translations are hosted on [Weblate](https://hosted.weblate.org/projects/capy-reader) and are open to everyone to add or update translations. If you don't see your language, feel free to add it!
### Pull Requests
If you want to create a pull request **please ask first.** This will save time in review, and save your time writing code if it doesn't fit for the app.
## Building the app
### Getting Started
1. Clone this repository
2. Install [Android Studio](https://developer.android.com/studio) if you don't have it already
3. Sync Gradle
4. In the toolbar, go to Run > Run 'app'
#### Build a signed release (Optional)
By default the app will build with a debug keystore. Follow the instructions below to build a signed release.
1. Ensure you have a keystore with the name `release.keystore` in the root directory.
2. Next, create a file called `secrets.properties`, also in the root directory, with the following values
```properties
key_alias=
store_password=
key_password=
```
[gplay_link]: https://play.google.com/store/apps/details?id=com.capyreader.app
[fdroid_link]: https://f-droid.org/packages/com.capyreader.app/
[izzy_link]: https://apt.izzysoft.de/fdroid/index/apk/com.capyreader.app
[izzy_img]: https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/com.capyreader.app&label=IzzyOnDroid
[github_link]: https://github.com/jocmp/capyreader/releases/latest
[github_img]: https://img.shields.io/github/v/release/jocmp/capyreader?logo=GitHub