XYZ Reader

XYZ Reader: A mock RSS feed reader featuring banner photos and shocking headlines! and project was created for the Android Developer Nanodegree program by Udacity. app meets the Material Design specifications based on some design specifications.

#ScreenShots

Libraries and tools included:

Support libraries
RecyclerViews and CardViews
RxJava and RxAndroid
Retrofit 2
Dagger 2
SqlBrite
Butterknife
Timber
Glide
AutoValue with extensions AutoValueParcel and AutoValueGson
Functional tests with Espresso
Robolectric
Mockito
Checkstyle, PMD and Findbugs for code analysis

Requirements

JDK 1.8
Android SDK.
Android N (API 24) .
Latest Android SDK Tools and build tools.

Architecture

This project follows ribot's Android architecture guidelines that are based on MVP (Model View Presenter). Read more about them here.

Code Quality

This project integrates a combination of unit tests, functional test and code analysis tools.

Tests

To run unit tests on your machine:

./gradlew test

To run functional tests on connected devices:

./gradlew connectedAndroidTest

Note: For Android Studio to use syntax highlighting for Automated tests and Unit tests you must switch the Build Variant to the desired mode.

Code Analysis tools

The following code analysis tools are set up on this project:

PMD: It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. See this project's PMD ruleset.

./gradlew pmd

Findbugs: This tool uses static analysis to find bugs in Java code. Unlike PMD, it uses compiled Java bytecode instead of source code.

./gradlew findbugs

Checkstyle: It ensures that the code style follows our Android code guidelines. See our checkstyle config file.

./gradlew checkstyle

The check task

To ensure that your code is valid and stable use check:

./gradlew check

This will run all the code analysis tools and unit tests in the following order:

Distribution

The project can be distributed using either Crashlytics or the Google Play Store.

Play Store

We use the Gradle Play Publisher plugin. Once set up correctly, you will be able to push new builds to the Alpha, Beta or production channels like this

./gradlew publishApkRelease

Read plugin documentation for more info.

Crashlytics

You can also use Fabric's Crashlytics for distributing beta releases. Remember to add your fabric account details to app/src/fabric.properties.

To upload a release build to Crashlytics run:

./gradlew assembleRelease crashlyticsUploadDistributionRelease

License

    Copyright 2015 Ribot Ltd.

    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.

therajanmaurya/XYZReader