Breadcrumb: Android Application

Android and Google Firebase application for Breadcrumb, an app to keep your friends and family updated with your locations during your travels.

The app allows a traveller to save a "breadcrumb" with the current location, time, and a custom description. Friends and family with the app receive a notification and are able to view previous breadcrumbs.

Inspired by the fairy tale Hansel and Gretel, children who drop breadcrumbs while following a witch into the woods so they can find their way back out.

Other Repositories

See the NodeJS server here: https://github.com/jleung51/breadcrumb-server

Setup

Android

Install Android Studio and import the project.

Firebase: Realtime Database

Breadcrumb requires a Firebase Realtime Database to store and share information.

First, modify the package name so you can attach your own database:

• In app/build.gradle, change the value of android.defaultConfig.applicationId
• In app/src/main, change the package name to match the new name

Create a project in Google Cloud.

Follow these instructions to create a Firebase Realtime Database, using your newly changed package name.

Credentials will be generated for you and downloaded as the file google-services.json. Place this file in the project directory, under app/app/. If you do not have this file:

• Navigate to the project in the Firebase console
• Click the Gear icon in the sidebar and select Project Settings
• Under the Your Apps section, download the google-services.json file

To view and manage your Database from the online portal, go to the Firebase Realtime Database console.

When you build and run the Android application, it will connect to your new database. Data structures will be created on the fly as required.

Creating a Production Release

Step 1: Building a Release Variant

Create a new file in the root directory to hold the secure keystore details:

cp keystore.properties.template keystore.properties

This file will be ignored by Git. Set your keystore information in this file.

Under Build, click Select Build Variant.

In the Build Variants view which appears, change the Active Build Variant from debug to release.

Build the application normally to your phone. The keystore credentials will be verified and applied.

Step 2: Creating the Signed App

Under Build, click Generate Signed Bundle / APK.

Follow the instructions, inputting your keystore path and credentials, to create a signed app which can be uploaded to the app store.

---

Work In Progress

Fonts

In app/src/main/res/font/:

• Add the .ttf files for your preferred fonts

In app/src/main/res/values/styles.xml:

• Configure PrimaryFont and PrimaryFontBold to use the new fonts

In app/src/main/res/values/colors.xml:

• Change the colors to the preferred style