2.71 KB
Newer Older
Christophe Henry's avatar
Christophe Henry committed
1 2 3 4
# FreshRSS Android application

Finally, an Android application specifically dedicated to the awesome [FreshRSS aggregator](

5 6 7 8 9
![splash screen](./fastlane/metadata/android/en-US/images/phoneScreenshots/1-splash-screen.png) ![login page](./fastlane/metadata/android/en-US/images/phoneScreenshots/2-login.png)  

![landing all](./fastlane/metadata/android/en-US/images/phoneScreenshots/3-landing-all.png) ![landing unread](./fastlane/metadata/android/en-US/images/phoneScreenshots/4-landing-unread.png)  

![subscription articles](./fastlane/metadata/android/en-US/images/phoneScreenshots/5-subscription-articles.png) ![article details](./fastlane/metadata/android/en-US/images/phoneScreenshots/6-article-detail.png)
Christophe Henry's avatar
Christophe Henry committed

11 12
![add feed panel](./fastlane/metadata/android/en-US/images/phoneScreenshots/11-add-feed.png)

Christophe Henry's avatar
Christophe Henry committed
13 14 15 16 17 18 19 20 21 22 23 24 25
## How to use?

First of all, set the API password. This password is different from the one you use for login into your account. 
You can set it on `https://<your_instance>/i/?c=user&a=profile`.

![API password setup page on /i/?c=user&a=profile](./fastlane/metadata/img/api-password.png)

Then, enter your regular account login, this password and the regular landing page URL of your FreshRSS instance. 
The application should compute the API URL automatically.

![API password setup page on /i/?c=user&a=profile](./fastlane/metadata/img/login.png)

26 27 28
## Contact & troubleshoot

If you need help for contributing or using the application, you can contact us by [joining us on Framateam]( or 
anonymously on the [`#freshrss`]( IRC channel on Freenode servers.

Christophe Henry's avatar
Christophe Henry committed
31 32 33 34 35 36 37
## Getting started

This project is a fairly standard Android application. As long as you use an correct setup of [Android studio](, 
everything should be fine.

## Running the tests

This project has no tests yet ¯\\\_(ツ)\_
Christophe Henry's avatar
Christophe Henry committed
39 40 41 42 43
There is an issue [about setting them up](, 
though, as well as one for [setting up a CI](

## Contributing

 Please refer to the [contributing guide](./
Christophe Henry's avatar
Christophe Henry committed
45 46 47 48 49 50 51 52 53 54

## License

This project is licenced under GNU GPL v.3. See [LICENSE](

## Aknowledgments

Thanks to [Marien Fressinaud](, 
[Alexandre Alapetite]( and all the FreshRSS contributors for their awesome work. 
And thanks again to Alexandre for helping in understanding their implementation of Google reader's API.