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.
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 your local.properties file like this:
MAPS_API_KEY_DEBUG=your_key_here
3. Run the app on your mobile phone or emulator with Google Play Services on it.
Right click on the test
or androidTest
packages and select Run Tests
1.androidTest
RemindersDaoTest - tests the RemindersDao methods to ensure that read / write / delete operations function as expected.
RemindersLocalRepositoryTest - Integration test between the RemindersLocalRepository and RemindersDao s' methods to ensure that read / write / delete operations function as expected.
ReminderListFragmentTest - tests the reminder's navigation functionality as well as the data ,available in the UI, to ensure that read/write/delete UI-related operations
function as expected and error-containing snackbar is displayed if applicable.
RemindersActivityTest - end-to-end black box test for the RemindersActivity , to ensure that the UX is smooth and the proper data and widgets are present in the UI during specific user interactions.
2. test
RemindersListViewModelTest - tests the methods of the RemindersListViewModel and the LiveData's values to ensure that read/write/delete operations deliver the expected output and error values are produced where applicable.
SaveReminderViewModelTest - tests the methods of the RemindersListViewModel and the LiveData's values to ensure that read/write/delete operations deliver the expected output and error values are produced where applicable.
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.
- 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.
Copyright 2021, Gergana Kirilova
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.