Skip to content

shlchoi/semaphore-android

Repository files navigation

Semaphore - Android

CircleCI

Semaphore is a system that monitors physical mailboxes for deliveries and notifies users when mail arrives. In addition, Semaphore also categorizes and counts the number of items that are currently inside the mailbox and displays the information to the user in an associated smartphone application.

This repository contains the Android Smartphone Component.

Semaphore was created for the Electrical and Computer Engineering Capstone Design Symposium 2017 at the University of Waterloo.

About Semaphore

See the main project page for more information.

Other Semaphore Repositories

Setup

  1. Clone project using git clone git@github.com:shlchoi/semaphore-android.git
  2. In the Firebase Console, create a new project
  3. Add a mobile Android app for the debug build variant using the package name ca.semaphore.app.debug
  4. Add another mobile Android app for the release build variant using the package name ca.semaphore.app
  5. Download the generated google-services.json file, and put it into the app/ folder
  6. Open project in Android Studio
  7. Download the Android Support Libraries using the built-in Android SDK Manager in Android Studio
  8. Create a file called keystore.properties in the root project folder
  9. Create a new keystore or using an existing one, and add the following information to keystore.properties
storeFile=[path to file]
storePassword=[password for the keystore]
keyAlias=[name of the key used for signing the application]
keyPassword=[password for the key]
  1. Build the application

Authors

Acknowledgments

License

Distributed under the GNU GPLv3 license. See LICENSE for more information.

Libraries are used under Google's Google API Terms of Service, Firebase's Terms of Service, the BSD License and Apache License 2.0.

BSD License

Apache License