Giter Club home page Giter Club logo

appboy-android-sdk's Introduction

Braze Logo

Android SDK

Successful marketing automation is essential to the future of your mobile app. Braze helps you engage your users beyond the download. Visit the following links for details and we'll have you up and running in no time!

Components

  • android-sdk-base - the Braze SDK base analytics library.
  • android-sdk-ui - the Braze SDK user interface library for in-app messages, push, and the news feed.
  • droidboy - a sample app demonstrating how to use Braze in-depth.
  • hello-appboy - a sample app demonstrating a basic Braze integration.
  • china-push-sample - a sample app demonstrating the Braze + Baidu push integration.
  • android-sdk-unity - a library that enables Braze SDK integrations on Unity.
  • samples - a folder containing several sample apps for various integration options.

Version Support

  • The Braze Android SDK supports Android 4.1+ / API 16+ (Jelly Bean and up).
  • Last Target SDK Version: 28
  • Last Compiled Support Library Version: 27.1.0
  • Last Compiled Google Play Services Version (Optional): playServicesVersion_PLACEHOLDER
  • Braze uses Font Awesome 4.3.0 for in-app message icons. Check out the cheat sheet to browse available icons.
  • Braze requires either a custom IAppboyImageLoader to display animated gif images.

Remote repository for gradle

The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

repositories {
   maven { url "https://appboy.github.io/appboy-android-sdk/sdk" }
   ...
}
dependencies {
   compile 'com.appboy:android-sdk-ui:3.1.+'
   ...
}

Installing android-sdk-ui to Your Local Maven Repository

To install the UI library as an AAR file to your local maven repository, run the install task with ./gradlew install. You can reference it with groupId com.appboy and artifactId android-sdk-ui. The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

repositories {
   mavenLocal()
   ...
}
dependencies {
  compile 'com.appboy:android-sdk-ui:3.1.+'
}

Building and Running the Sample Applications

  1. Make sure the ANDROID_HOME environment variable is set to the location of your installed SDK or you have a local.properties file which defines the sdk.dir property. You can check this by running echo $ANDROID_HOME, or echo %ANDROID_HOME% in Windows.
  2. To assemble the UI library and the Droidboy APK, run ./gradlew assemble (use gradlew.bat on Windows). You can find assembled files in the build/ subdirectories of the android-sdk-ui and droidboy projects. You can also use the installDebug task if you have a device or emulator connected to adb and want to run Droidboy or Hello-Appboy. You can see other available tasks by running ./gradlew tasks.

Questions?

If you have questions, please contact [email protected].

appboy-android-sdk's People

Contributors

billmag avatar briancaw avatar bucimis avatar catacom avatar gkaffka avatar marchy avatar martinmcroyappboy avatar matrixy avatar mnonnenmacher avatar radixdev avatar tobiblas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.