# Android
## Gradle Installation
### Prerequisite
SDK supports Android 5.0 (API Level 21) and above
```gradle
android {
...
defaultConfig {
minSDKVersion 21 // at least 21
}
}
```
### Installation
Add the Jitpack repository in your project level `build.grade` at the end of repositories:
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
Add the dependency in your module level `build.grade.` Find latest UIKit version at [Changelog](https://docs.social.plus/social-plus-uikit/changelogs/changelog-1).
```gradle
// add buildFeatures, compileOptions and kotlinOptions in android tag
android {
buildFeatures {
dataBinding = true
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = JavaVersion.VERSION_1_8
}
}
dependency {
implementation 'com.github.AmityCo.Amity-Social-Cloud-UIKit-Android:amity-uikit:x.y.z'
}
```
### Managing Conflicting File Generation
In your app module's `build.gradle` , add the following packaging options.
```kotlin
android {
...
packagingOptions {
exclude 'META-INF/INDEX.LIST'
exclude 'META-INF/io.netty.versions.properties'
}
}
```
***
## Open-source Installation
With open source, developers have more flexibility and greater customization options, allowing you to have complete control over the visual style. Open sourcing allows for more transparency and visibility, and enables contributions from a greater developer community in terms of good design, implementation, code improvement, and fixes, translating into a better product and development experience.
### Migrate Android Open Source UI Kit with Existing Project
#### Remove existing gradle dependency
If you've never used UI Kit from a gradle dependency before, you may skip this step and proceed to the next step. If you are migrating the UIKit with an existing gradle dependency, you will need to remove it from the gradle at the application level.
```
implementation 'com.github.AmityCo.Amity-Social-Cloud-UIKit-Android:amity-uikit:x.y.z'
```
#### Import UI Kit module to your existing project
* Clone or download source code from an open-source Github repository.
* Navigate to your current application in Android Studio, then at the top navigation bar go to **File > New > Import Module...**
* Choose the source directory where you downloaded/cloned UI Kit source code.
* Make sure that you import `:chat` , `:common`, `:social`, and `:amity-uikit` module as per the screenshot described. The `:sample` module is optional and solely contains examples of UIKit Fragments and Activities.
* Navigate to the root project's `settings.gradle` file once the modules have been successfully imported. You may see that Android Studio generated a dependency path from the UI Kit source code directory you specified initially. However, there's a chance that Android Studio won't do so or may generate the incorrect path. Please double-check that the path is accurate.
* Additionally, in the root project's `settings.gradle` it's also mandatory to declare jitpack.io repository destination by adding `maven { url https://jitpack.io }` to **dependencyResolutionManagement > repositories**.
* Add the imported module to application's gradle file by adding:
```
implementation project(path: ':amity-uikit')
```
* Exclude these META-INF from the packaging options in application's gradle
```
packagingOptions {
exclude 'META-INF/INDEX.LIST'
exclude 'META-INF/io.netty.versions.properties'
}
```
* Lastly, apply this in the `project-level` build.gradle file. `apply from: "../Amity-Social-Cloud-UIKit-Android/buildsystem/dependencies.gradle"`
{% hint style="info" %}
Also make sure that your settings `android.nonTransitiveRClass=false` in `gradle.properties` file
{% endhint %}
Woohoo! All set now you're ready to explore and modify our UI Kit in your application project.
### Modifying Android Open Source UI Kit
You can modify the Android open source UI Kit to customize behaviors to fit your needs. To modify the code, simply copy and paste it into your local machine.
We recommend that you first fork the repository before starting any customization work, so that it will be easier to merge the code with the next version update that we provide from the main repository.
Reference on forking:
### Get Latest Open Source UI Kit Updates
To update to the latest version of the UI Kit, you can pull the latest commit of the git submodule.
```
cd Amity-Social-Cloud-UIKit-Android-OpenSource
git pull origin master
git checkout tags/4.0.0-beta01
cd ..
git add .
git commit -m “Update android uikit opensource submodule”
git push origin branch_name
```
