-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
34 changed files
with
2,033 additions
and
1 deletion.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# kyandroid | ||
All notable changes to this project will be documented in this file. | ||
|
||
## [Unreleased] | ||
|
||
## [1.0.0-rc1] - 2017-08-30 | ||
### Added | ||
- retrofit wrapper as Reztrofit | ||
- Realm util classes as local data management | ||
- session management using localdata | ||
|
||
|
||
[Unreleased]: https://github.com/rezkyatinnov/kyandroid/compare/1.0.0-rc1...HEAD | ||
[1.0.0-rc1]: https://github.com/rezkyatinnov/kyandroid/releases/tag/1.0.0-rc1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,74 @@ | ||
# kyandroid-base | ||
# Kyandroid | ||
|
||
![license](https://img.shields.io/npm/l/node-readme.svg) | ||
|
||
A reusable libraries wrapper to kick start an android project. Current version featuring Retrofit and Realm. Easier use of retrofit and realm. Easy session management (stored on realm) | ||
|
||
## Features | ||
- Rest client using Retrofit | ||
- Local data management using Realm | ||
- Session Management using LocalData on Realm | ||
|
||
## Install | ||
See complete guide of install by jitpack [here](https://jitpack.io/#rezkyatinnov/kyandroid) | ||
|
||
### gradle | ||
#### 1. Add the JitPack repository to your build file | ||
```groovy | ||
allprojects { | ||
repositories { | ||
... | ||
maven { url 'https://jitpack.io' } | ||
} | ||
} | ||
``` | ||
#### 2. Add the dependency | ||
```groovy | ||
dependencies { | ||
compile 'com.github.rezkyatinnov:kyandroid:1.0.0-rc1' | ||
} | ||
``` | ||
|
||
## Usage | ||
|
||
### Initiate in Custom Application Class or Launcher Activity | ||
#### Kotlin Example | ||
```kotlin | ||
class ExampleApp: Application() { | ||
override fun onCreate() { | ||
super.onCreate() | ||
Kyandroid.setDbKey("replace this with 64 long string") | ||
Kyandroid.init(this, | ||
"http://api.example.com/", ExampleRestService::class.java, | ||
"Shared Preff Name",Context.MODE_PRIVATE) | ||
} | ||
} | ||
``` | ||
#### Java Example | ||
```java | ||
public class ExampleApp extends Application { | ||
@Override | ||
public void onCreate() { | ||
super.onCreate(); | ||
Kyandroid.setDbKey("replace this with 64 long string"); | ||
Kyandroid.init(this, | ||
"http://api.example.com/", ExampleRestService.class, | ||
"Shared Preff Name",Context.MODE_PRIVATE); | ||
} | ||
} | ||
``` | ||
Currently an example project is in progress. you can check them [here](https://github.com/rezkyatinnov/kyandroid-sample) | ||
|
||
### | ||
|
||
## Contributing | ||
|
||
Contributions welcome; Please submit all pull requests against the develop branch. This repo is following gitflow branching model [GitFLow](https://datasift.github.io/gitflow/IntroducingGitFlow.html). If your pull request contains JavaScript patches or features, you should include relevant unit tests. Thanks! | ||
|
||
## Author | ||
|
||
[Rezkya Tinnov](http://github.com/rezkyatinnov) : <mailme@rezkyatinnov.com> | ||
|
||
## License | ||
|
||
- **MIT** : http://opensource.org/licenses/MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
// Top-level build file where you can add configuration options common to all sub-projects/modules. | ||
|
||
buildscript { | ||
ext.kotlin_version = '1.1.4-2' | ||
repositories { | ||
google() | ||
jcenter() | ||
} | ||
dependencies { | ||
classpath 'com.android.tools.build:gradle:3.0.0-beta2' | ||
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" | ||
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5' | ||
classpath "io.realm:realm-gradle-plugin:3.5.0" | ||
|
||
// NOTE: Do not place your application dependencies here; they belong | ||
// in the individual module build.gradle files | ||
} | ||
} | ||
|
||
allprojects { | ||
repositories { | ||
google() | ||
jcenter() | ||
maven { url "https://jitpack.io" } | ||
} | ||
} | ||
|
||
task clean(type: Delete) { | ||
delete rootProject.buildDir | ||
} | ||
|
||
project.ext.compileSdkVersion = 26 | ||
project.ext.buildToolsVersion = "26.0.0" | ||
project.ext.minSdkVersion = 15 | ||
project.ext.targetSdkVersion = 26 | ||
project.ext.googleAPIsVersion = "26.0.0" | ||
|
||
project.ext.publishVersionCode = 18 | ||
project.ext.publishVersionName = "1.0.0-rc1" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Project-wide Gradle settings. | ||
|
||
# IDE (e.g. Android Studio) users: | ||
# Gradle settings configured through the IDE *will override* | ||
# any settings specified in this file. | ||
|
||
# For more details on how to configure your build environment visit | ||
# http://www.gradle.org/docs/current/userguide/build_environment.html | ||
|
||
# Specifies the JVM arguments used for the daemon process. | ||
# The setting is particularly useful for tweaking memory settings. | ||
org.gradle.jvmargs=-Xmx1536m | ||
|
||
# When configured, Gradle will run in incubating parallel mode. | ||
# This option should only be used with decoupled projects. More details, visit | ||
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects | ||
# org.gradle.parallel=true |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#Tue Aug 08 12:06:11 MYT 2017 | ||
distributionBase=GRADLE_USER_HOME | ||
distributionPath=wrapper/dists | ||
zipStoreBase=GRADLE_USER_HOME | ||
zipStorePath=wrapper/dists | ||
distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-rc-1-all.zip |
Oops, something went wrong.