https://github.com/bucketeer-io/android-client-sdk
Bucketeer Client-side SDK for Android
https://github.com/bucketeer-io/android-client-sdk
ab-testing android feature-flags kotlin sdk trunk-based-development
Last synced: 11 months ago
JSON representation
Bucketeer Client-side SDK for Android
- Host: GitHub
- URL: https://github.com/bucketeer-io/android-client-sdk
- Owner: bucketeer-io
- License: apache-2.0
- Created: 2022-07-25T10:46:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T11:11:01.000Z (12 months ago)
- Last Synced: 2025-04-08T12:24:55.015Z (12 months ago)
- Topics: ab-testing, android, feature-flags, kotlin, sdk, trunk-based-development
- Language: Kotlin
- Homepage: https://docs.bucketeer.io/sdk/client-side/android
- Size: 717 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/bucketeer-io/android-client-sdk/actions/workflows/build.yml)
# Bucketeer Client-side SDK for Android
## Setup
Install prerequisite tools.
- Android Studio Chipmunk or later
- Java 11
Then, you need to create `local.properties`.
```
# build
sdk.dir= # e.g. /Users//Library/Android/sdk
# test
api_key=
api_endpoint= # e.g. api.example.jp
# sample
sample.use_released_sdk=false
sample.sdk_version=
```
## Development
### Development with Android Studio
Open Android Studio and import `android-client-sdk`.
### Development with command line
#### project :bucketeer (SDK)
Displays the tasks runnable from project ':bucketeer'.
```
./gradlew :bucketeer:tasks
```
Runs lint on the Debug build.
```
./gradlew :bucketeer:lintDebug
```
Run unit tests for the debug build.
```
./gradlew :bucketeer:testDebugUnitTest
```
Deletes the build directory and assembles all Release builds. (Create `./bucketeer/build/outputs/aar/bucketeer-release.aar`)
```
./gradlew clean :bucketeer:assembleRelease
```
Installs and runs the e2e tests for debug on connected devices. Open Android Emulator, then run the command below.
```
./gradlew :bucketeer:connectedCheck
```
#### project :sample (Sample)
Displays the tasks runnable from project ':sample'.
```
./gradlew :sample:tasks
```
Deletes the build directory and assembles all Release builds. (Create `./sample/build/outputs/apk/sample-release.apk`)
```
./gradlew clean :sample:assembleRelease
```
### Tips
#### Use published SDK in Sample
If you want to use published SDK instead of local one, change `local.properties` like below,
(check SDK versions [here](https://repo1.maven.org/maven2/jp/bucketeer/sdk-android/))
```
# sample
sample.use_released_sdk=true
sample.sdk_version=X.Y.Z
```
then build and start the sample app.
## Contributing
[CONTRIBUTING.md](./CONTRIBUTING.md)
## SDK User Docs
- [Tutorial](https://docs.bucketeer.io/sdk/client-side/android)