https://github.com/therajanmaurya/xyzreader
XYZ Reader Android Application During the Nanodegree program by Udacity
https://github.com/therajanmaurya/xyzreader
android android-sdk butterknife checkstyle dagger2 http3 mvc-framework retrofit2
Last synced: 4 months ago
JSON representation
XYZ Reader Android Application During the Nanodegree program by Udacity
- Host: GitHub
- URL: https://github.com/therajanmaurya/xyzreader
- Owner: therajanmaurya
- License: apache-2.0
- Created: 2016-12-05T11:20:18.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-31T14:12:48.000Z (almost 9 years ago)
- Last Synced: 2025-03-27T14:53:06.529Z (7 months ago)
- Topics: android, android-sdk, butterknife, checkstyle, dagger2, http3, mvc-framework, retrofit2
- Language: Java
- Homepage:
- Size: 1.87 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/ReactiveX/RxJava) and [RxAndroid](https://github.com/ReactiveX/RxAndroid)
- [Retrofit 2](http://square.github.io/retrofit/)
- [Dagger 2](http://google.github.io/dagger/)
- [SqlBrite](https://github.com/square/sqlbrite)
- [Butterknife](https://github.com/JakeWharton/butterknife)
- [Timber](https://github.com/JakeWharton/timber)
- [Glide](https://github.com/bumptech/glide)
- [AutoValue](https://github.com/google/auto/tree/master/value) with extensions [AutoValueParcel](https://github.com/rharter/auto-value-parcel) and [AutoValueGson](https://github.com/rharter/auto-value-gson)
- Functional tests with [Espresso](https://google.github.io/android-testing-support-library/docs/espresso/index.html)
- [Robolectric](http://robolectric.org/)
- [Mockito](http://mockito.org/)
- [Checkstyle](http://checkstyle.sourceforge.net/), [PMD](https://pmd.github.io/) and [Findbugs](http://findbugs.sourceforge.net/) for code analysis
## Requirements
- JDK 1.8
- [Android SDK](http://developer.android.com/sdk/index.html).
- Android N [(API 24) ](http://developer.android.com/tools/revisions/platforms.html).
- Latest Android SDK Tools and build tools.
## Architecture
This project follows ribot's Android architecture guidelines that are based on [MVP (Model View Presenter)](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93presenter). Read more about them [here](https://github.com/ribot/android-guidelines/blob/master/architecture_guidelines/android_architecture.md).
## 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](https://pmd.github.io/): It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. See [this project's PMD ruleset](config/quality/pmd/pmd-ruleset.xml).
```
./gradlew pmd
```
* [Findbugs](http://findbugs.sourceforge.net/): 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](http://checkstyle.sourceforge.net/): It ensures that the code style follows [our Android code guidelines](https://github.com/ribot/android-guidelines/blob/master/project_and_code_guidelines.md#2-code-guidelines). See our [checkstyle config file](config/quality/checkstyle/checkstyle-config.xml).
```
./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](http://support.crashlytics.com/knowledgebase/articles/388925-beta-distributions-with-gradle) or the [Google Play Store](https://github.com/Triple-T/gradle-play-publisher).
### 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](https://github.com/Triple-T/gradle-play-publisher) 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.
```