As part of the capstone computer science course at MS&T, a check-in app for a local homeless shelter was created. The app is designed to run on an android tablet. Those looking to spend the night at The Rolla Mission can register using the tablet, and on any future visits, can check in to indicate they will be spending the night.
A strong effort was made to use the best-practices of android development:
- MVVM structure
- Dependency injection via Dagger
- Connection to external API using Retrofit
- Local database with Room
- Styling with Google Material
- Unit testing (instrumented and non-instrumented)
To run the app, open its build.gradle file in android studio. For the app to be functional, it must connect to the companion Django web app.
- Ensure that the Django app is running locally (follow the instructions at https://github.com/Thomas-McKanna/TheRollaMissionDjango).
- Take note of your IP address (https://www.howtogeek.com/233952/how-to-find-your-routers-ip-address-on-any-computer-smartphone-or-tablet/).
- Change app/java/com.project.therollamissionapp/di/AppModule so that the API_BASE_URL uses your IP address.
- In the root of the project, make a file called secret.properties and populate it like this:
API_USER="<YOU DECIDE THE USERNAME>"
API_PASS="<YOU DECIDE THE PASSWORD>"
- In the Django app, go to the admin interface and add a user with the credentials you chose above.