Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/hossain-khan/android-daily-headlines

An app that provides daily headlines from popular news source.
https://github.com/hossain-khan/android-daily-headlines

android-application daily-headlines news-sources rxjava sample-app swagger-codegen

Last synced: 3 months ago
JSON representation

An app that provides daily headlines from popular news source.

Awesome Lists containing this project

README 

          
[![CircleCI](https://circleci.com/gh/amardeshbd/android-daily-headlines.svg?style=svg)](https://goo.gl/dc1ogR) [![Build Status](https://travis-ci.org/amardeshbd/android-daily-headlines.svg?branch=develop)](https://goo.gl/iqP7aU) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/33be4683227a4d1e83cea377562dcc09)](https://goo.gl/LgMlnk) [![codebeat badge](https://codebeat.co/badges/e2dd5a2b-0d57-4946-9696-17f82366395f)](https://goo.gl/WfcZFA) [![release](https://img.shields.io/github/release/amardeshbd/android-daily-headlines.svg)](https://github.com/amardeshbd/android-daily-headlines/releases) [![license](https://img.shields.io/github/license/amardeshbd/android-daily-headlines.svg?maxAge=2592000)](https://github.com/amardeshbd/android-daily-headlines/blob/develop/LICENSE) ![](https://img.shields.io/badge/AS%20Compatibility-v3.3.2-green.svg?logo=android)   

[![GitHub issues](https://img.shields.io/github/issues/amardeshbd/android-daily-headlines.svg)](https://github.com/amardeshbd/android-daily-headlines/issues) [![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/amardeshbd/android-daily-headlines.svg?maxAge=2592000)](https://github.com/amardeshbd/android-daily-headlines/issues?q=is%3Aissue+is%3Aclosed) [![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/amardeshbd/android-daily-headlines.svg?maxAge=2592000)](https://github.com/amardeshbd/android-daily-headlines/pulls?q=is%3Apr+is%3Aclosed) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/amardeshbd/android-daily-headlines.svg)](http://isitmaintained.com/project/amardeshbd/android-daily-headlines "Average time to resolve an issue") [![Percentage of issues still open](http://isitmaintained.com/badge/open/amardeshbd/android-daily-headlines.svg)](http://isitmaintained.com/project/amardeshbd/android-daily-headlines "Percentage of issues still open")  



# android-daily-headlines

An app that provides daily headlines from popular news source.



Initial planning stage, main goal is to create simple app with news source title '**only**' to keep it simple. This app is meant to take a glance through the headlines quickly with possible option to view details of the story _(future version)_.



[![Google Play Store - App Download](https://play.google.com/intl/en_us/badges/images/badge_new.png)](https://goo.gl/fRrc7o) [![Google Play Store - Beta Testing](https://cloud.githubusercontent.com/assets/99822/20126090/733ec0a4-a600-11e6-8ba8-8834413f3886.png)](https://goo.gl/z3RH9k)



## Building and Contribution Guide

The app uses gradle, follow [firebase android](https://firebase.google.com/docs/android/setup) setup guide to get `google-services.json` and **replace** them in both **`mobile`** and **`tv`** module.



> NOTE: Currently dummy `google-services.json` files are added to pass CI build. You must **replace** them with your's to build project properly.  



Contribution is welcome via :octocat: pull-request. Checkout open issue to get pointer on what you can help us with :thumbsup:



## Goal and Status



Current plan is to create simple possible 📺 app with news headline only. This allows users to quickly glance through headlines over a ☕



The 📱 version of the app will follow after 2.0 release of 📺 _(TV)_ app.



### Project Planning

I am currently tracking issues and tasks using :octocat:'s kanban board



 * ~~Release v1 - https://github.com/amardeshbd/android-daily-headlines/projects/1~~ - 1.0 is published in [Google Play](https://play.google.com/store/apps/details?id=info.hossainkhan.dailynewsheadlines&utm_source=global_co&utm_medium=prtnr&utm_content=Mar2515&utm_campaign=PartBadge&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1)

 * Release v2 - https://github.com/amardeshbd/android-daily-headlines/projects/2



### Gradle Modues

[![android-daily-headlines-module-overview](https://cloud.githubusercontent.com/assets/99822/19424108/8593d212-93f4-11e6-9caa-c3cc4d2e4481.png)](https://docs.google.com/drawings/d/1mbFW9Yq9r7h7DmFYhA6X1M26dBp7Uw-mX4aRaPm4GMg/edit?usp=sharing)



For more infromation check **[project wiki](https://github.com/amardeshbd/android-daily-headlines/wiki)**



### Screenshot from `develop` build



![device-2016-11-09-231920](https://cloud.githubusercontent.com/assets/99822/20164469/1947d71a-a6d3-11e6-9e17-e357daca49d9.png)



[![mobile-demo](https://user-images.githubusercontent.com/99822/37881945-6e1e44e4-306c-11e8-814e-32f2fddc215b.png)](https://user-images.githubusercontent.com/99822/37881767-6b22debe-306a-11e8-848c-4175dd5e358f.gif)



----



## DISCLAIMER

This is my personal project to experiment with following tools & technologies

 * Firebase - Analytics _(See [#111](https://github.com/amardeshbd/android-daily-headlines/pull/111))_, Crash Reporting _(See [#10](https://github.com/amardeshbd/android-daily-headlines/pull/10))_, Remote Config etc.

 * Travis CI - for build automation _(See [travis.yml](https://github.com/amardeshbd/android-daily-headlines/blob/develop/.travis.yml))_

 * Code coverage (jacoco _[See [travis.yml](https://github.com/amardeshbd/android-daily-headlines/blob/develop/.travis.yml#L32)]_,  [Codecov.io](https://codecov.io/gh/amardeshbd/android-daily-headlines), [codacy](https://www.codacy.com/app/amardeshbd/android-daily-headlines), [codebeat](https://codebeat.co/projects/github-com-amardeshbd-android-daily-headlines))

 * OpenAPI Specification & Related Tools _(See [#11](https://github.com/amardeshbd/android-daily-headlines/pull/11), [wiki](https://github.com/amardeshbd/android-daily-headlines/wiki/Swagger-Codegen))_

 * RxJava _(Using for retrofit and app)_

 * Jack & Jill Toolchain - _Used for Java 8 support_ (LIMITATION: I was not able to use Java 8 feature due to library project not being supported by jack. See AOSP [issue #211386](https://code.google.com/p/android/issues/detail?id=211386))

 * Retrofit 2 _(See [API Services](https://github.com/amardeshbd/android-daily-headlines/tree/develop/api-lib/src/main/java/io/swagger/client/api))_

 * Dagger 2 _(See [#29](https://github.com/amardeshbd/android-daily-headlines/issues/29), [core-lib:gradle](https://github.com/amardeshbd/android-daily-headlines/blob/develop/core-lib/build.gradle#L50))_

 * Picasso - _Used for memory efficient image loading_

 * Coordinator & Constraint Layout

 * Timber (android logging) _(See [#30](https://github.com/amardeshbd/android-daily-headlines/pull/30))_

 * Android TV Leanback _(Most code samples are taken from "[leanback-showcase](https://github.com/googlesamples/leanback-showcase)" project)_

 * Design Support Library

 * Database (local caching - Realm (maybe?))

 * Scheduler - data syncing

 * MVP Architecture _(See [#27](https://github.com/amardeshbd/android-daily-headlines/issues/27), some UI still needs refactoring)_

 * AutoValue _(See [#76](https://github.com/amardeshbd/android-daily-headlines/pull/76))_

 * Google Play Alpha Beta release _(Beta app available on [Google Play](https://play.google.com/apps/testing/info.hossainkhan.dailynewsheadlines))_

 * LeakCanary _(See [#60](https://github.com/amardeshbd/android-daily-headlines/pull/60))_



Features started using in the mobile app:

 * Kotlin Support _(See [#175](https://github.com/amardeshbd/android-daily-headlines/issues/175))_

 * Room ORM (Planned for content caching)

 * Upgrade to RxJava 2 (Planned)

 * Upgrade to Firebase Crashlytics (Planned)

 

I'll try to update references for these items when I use in the app :sunglasses: