location-reminders's Introduction

Location Reminder

A Todo list app with location reminders that remind the user to do something when he reaches a specific location. The app will require the user to create an account and login to set and access reminders.

Getting Started

Clone the project to your local machine.
Open the project using Android Studio.

Dependencies

1. A created project on Firebase console.
2. A create a project on Google console.

Installation

Step by step explanation of how to get a dev environment running.

1. To enable Firebase Authentication:
        a. Go to the authentication tab at the Firebase console and enable Email/Password and Google Sign-in methods.
        b. download `google-services.json` and add it to the app.
2. To enable Google Maps:
    a. Go to APIs & Services at the Google console.
    b. Select your project and go to APIs & Credentials.
    c. Create a new api key and restrict it for android apps.
    d. Add your package name and SHA-1 signing-certificate fingerprint.
    c. Enable Maps SDK for Android from API restrictions and Save.
    d. Copy the api key to the `google_maps_api.xml`
3. Run the app on your mobile phone or emulator with Google Play Services in it.

Testing

Right click on the test or androidTest packages and select Run Tests

Break Down Tests

Explain what each test does and why

1.androidTest
        //TODO: Students explain their testing here.
2. test
        //TODO: Students explain their testing here.

Built With

Koin - A pragmatic lightweight dependency injection framework for Kotlin.
FirebaseUI Authentication - FirebaseUI provides a drop-in auth solution that handles the UI flows for signing
JobIntentService - Run background service from the background application, Compatible with >= Android O.