Kotlin-Android-Boilerplate - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #go #machine-learning #deep-learning #linux #nodejs #cli #awesome-list #vue #pytorch #ios

Kotlin-Android-Boilerplate

(★ 277)

Kotlin Android boilerplate project with MVVM architecture using RxJava, Dagger 2, and more!

File Explorer

Download Latest Version (.zip)

- .gitignore
- build.gradle
- lint.xml
- proguard-rules.pro
- - detail.png
  - detail_night.png
  - list.png
  - list_night.png
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.gitignore
build.gradle
ci.sh
circle.yml
gradle.properties
gradlew
gradlew.bat
LICENSE.md
README.md
settings.gradle
signing.properties.sample

# Installation Guide

1. Get the code

git clone https://github.com/Plastix/Kotlin-Android-Boilerplate

Downloads the entire project code from GitHub to your computer.

cd Kotlin-Android-Boilerplate

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

./gradlew assembleDebug

Builds the project using Gradle.

./gradlew test

Builds the project using Gradle.

./gradlew connectedAndroidTest

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Kotlin-Android-Boilerplate [![CircleCI](https://img.shields.io/circleci/project/Plastix/Kotlin-Android-Boilerplate/master.svg)](https://circleci.com/gh/Plastix/Kotlin-Android-Boilerplate)

<p align="center">
    <img src="app/src/main/res/mipmap-xxxhdpi/ic_web.png" width="200">
</p>

An MVVM Boilerplate Android project written in [Kotlin](https://kotlinlang.org/). This sample
application fetches the top starred Kotlin repositories from Github and displays them. Inspired by
@hitherejoe's [Android-Boilerplate](https://github.com/hitherejoe/Android-Boilerplate) project.

>**Note**:
>This project was developed before Google's introduction of Android Architecture Components at I/O 2017. I strongly encourage that you read their [application architecture guide](https://developer.android.com/topic/libraries/architecture/guide.html).

## Screenshots
<img src="art/screenshots/list.png" width="49%" />
<img src="art/screenshots/detail.png" width="49%" />

<img src="art/screenshots/list_night.png" width="49%" />
<img src="art/screenshots/detail_night.png" width="49%" />

## Libraries
* [Dagger 2](http://google.github.io/dagger/)
* [RxJava 2](https://github.com/ReactiveX/RxJava) and [RxAndroid](https://github.com/ReactiveX/RxAndroid)
* [Retrofit 2](http://square.github.io/retrofit/)
* [Picasso](http://square.github.io/picasso/)
* [Google Support Libraries](http://developer.android.com/tools/support-library/index.html)

## Testing Libraries
* [JUnit](http://junit.org/junit4/)
* [Mockito](http://mockito.org/)

## Requirements
To compile and run the project you'll need:

- [Android SDK](http://developer.android.com/sdk/index.html)
- [Android N (API 25)](http://developer.android.com/tools/revisions/platforms.html)
- Android SDK Tools
- Android SDK Build Tools `24.0.3`
- Android Support Repository
- [Kotlin](https://kotlinlang.org/) `1.0.6`
- Kotlin plugin for Android Studio

Building
--------

To build, install and run a debug version, run this from the root of the project:

```
./gradlew assembleDebug
```

Testing
-------

To run **unit** tests on your machine:

```
./gradlew test
```

To run **instrumentation** tests on connected devices:

```
./gradlew connectedAndroidTest
```

## Release Builds
A release build needs to be signed with an Android Keystore. The easiest way to generate a keystore is to open
Android Studio and go to `Build -> Generate Signed Apk -> Create New...` After that you need to create a
`signing.properties` file in the root directory and add the following info to it:
```INI
STORE_FILE=/path/to/your.keystore
STORE_PASSWORD=yourkeystorepass
KEY_ALIAS=projectkeyalias
KEY_PASSWORD=keyaliaspassword
```
Running `./gradlew assembleRelease` will then build and sign a release version of the app.

## FAQ
#### Why Kotlin?
In a nutshell, Kotlin throws all the bad parts of Java out the window and brings lots of great features from
Java 8 and functional programming (Yet still compiling to Java 6 bytecode). Kotlin brings much needed language
features to Android which is stuck on Java 6.

#### What is with all the interfaces?

By default Kotlin classes are closed (`final`). This makes them hard to mock unless you use a tool like
[Powermock](https://github.com/jayway/powermock). I'd rather just mock interfaces with [Mockito](http://mockito.org/)
than go through the hassle of using Powermock.

**Update**: [Mockito 2.0](https://github.com/mockito/mockito/wiki/What%27s-new-in-Mockito-2) Supports mocking
 static and final out of the box. Thus, it removes the need for all of these interfaces.

#### How do I use this project?
This is a boilerplate project aimed to help bootstrap new Kotlin applications. Feel free to fork this application
or use this project [generator](https://github.com/ravidsrk/generator-kotlin-android-boilerplate). Don't
forget to change the following things for your application:

* Application ID (Gradle)
* Application Name (String resource)
* Package names

## Attributions
- [Kotlin Logo](http://instantlogosearch.com/kotlin)
- [Github Icons](https://octicons.github.com/)