Sample Apps

Braze’s SDKs each come with a sample application within the repository for your convenience. Each of these apps is fully buildable so you can test Braze features alongside implementing them within your own applications. Testing behavior within your own application versus expected behavior and codepaths within the sample applications is an excellent way to debug any problems you may run into.

Building the Droidboy Test Application

Braze’s test application within the Android SDK github repository is called Droidboy. Follow the instructions below to build a fully functional copy of it alongside your project.

• Create a new “App Group” and note the Braze API key.
• Copy your FCM Sender ID and Braze API key into the appropriate places within /droidboy/res/values/appboy.xml (in between the tags for the strings named “com_appboy_push_fcm_sender_id” and “com_appboy_api_key”, respectively).
• Copy your FCM API Key into your “App Settings” page.

• To assemble the Droidboy APK run the following command within the SDK directory:

  1
  ./gradlew assemble
  

  Use gradlew.bat on Windows

• To automatically install the Droidboy APK on a test device run the following command within the SDK directory:

  1
  ./gradlew installDebug
  

Building the Hello Braze Test Application

The Hello Braze test application shows a minimal use case of the Braze SDK, and additionally shows how to easily integrate the Braze SDK into a gradle project.

1. Copy your API key from your “App Settings” page into your appboy.xml file in the res/values folder.

2. To install the sample app to a device or emulator, run the following command within the SDK directory:

   1
     ./gradlew installDebug
   

If you don’t have your ANDROID_HOME variable properly set or don’t have a local.properties folder with a valid sdk.dir folder, this plugin will also install the base SDK for you. See the plugin repo for more information.

For more information on the Android SDK build system see the Github Repository readme.