Put MAPS_API_KEY= inside local.properties
Put google-services.json inside folder app
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.
- Clone the project to your local machine.
- Open the project using Android Studio.
1. A created project on Firebase console.
2. A create a project on Google console.
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.
Right click on the test or androidTest packages and select Run Tests
Explain what each test does and why
1.androidTest
- RemindersDaoTest (SmallTest)
a) saveReminders_getReminderByIdEqualToInput : Given reminders dao when save reminders then check reminder is equal to input
b) saveReminders_getRemindersIsNotEmpty : Given reminders dao when save reminders then check reminders is not empty
c) deleteReminders_getRemindersIsEmpty : Given reminders dao when delete all reminders then check reminders is empty
- RemindersLocalRepositoryTest (MediumTest)
a) saveReminders_getReminderByIdIsEqualToInput : Given reminders local repository when save reminders then check reminder is equal to input
b) deleteReminders_getRemindersIsEmpty : Given reminders local repository when delete all reminders then check reminders is empty
- RemindersListFragmentTest (MediumTest)
a) clickAddReminderFAB_navigateToSaveReminderFragment : Given reminders list fragment when click add reminder then navigate to savereminder
b) clickReminderItem_navigateToReminderDescriptionActivity : Given reminders list fragment when click add reminder then navigate to description activity
- RemindersActivityTest (LargeTest)
a) addNewReminder : Given reminders activity when add new reminder then recyclerview is not empty
2. test
- SaveReminderViewModelTest
a) `GIVEN correct data WHEN validate entered data THEN result is true`
b) `GIVEN incorrect data WHEN validate entered data THEN result is false`
c) `GIVEN input data WHEN save reminder THEN result data is equal to input data`
d) `GIVEN POI data WHEN commit POI THEN coordinates and location name is equal POI data`
e) `GIVEN selected data WHEN on clear data THEN data cleared`
- RemindersListViewModelTest
a) `WHEN load reminders THEN value is not empty`
1. Create a Login screen to ask users to login using an email address or a Google account. Upon successful login, navigate the user to the Reminders screen. If there is no account, the app should navigate to a Register screen.
2. Create a Register screen to allow a user to register using an email address or a Google account.
3. Create a screen that displays the reminders retrieved from local storage. If there are no reminders, display a "No Data" indicator. If there are any errors, display an error message.
4. Create a screen that shows a map with the user's current location and asks the user to select a point of interest to create a reminder.
5. Create a screen to add a reminder when a user reaches the selected location. Each reminder should include
a. title
b. description
c. selected location
6. Reminder data should be saved to local storage.
7. For each reminder, create a geofencing request in the background that fires up a notification when the user enters the geofencing area.
8. Provide testing for the ViewModels, Coroutines and LiveData objects.
9. Create a FakeDataSource to replace the Data Layer and test the app in isolation.
10. Use Espresso and Mockito to test each screen of the app:
a. Test DAO (Data Access Object) and Repository classes.
b. Add testing for the error messages.
c. Add End-To-End testing for the Fragments navigation.
- APK file of the final project.
- Git Repository with the code.
- 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.