README.md

Boston on Time (BoT)

Project Summary

This project starts from a mobile development course(CS501) in Boston University by a group of talented and interesting students.

Its original intention is to build a mobile app(BoT) that can help everyone in Boston city to have a better experience when taking public transportation(MBTA).

For every commuter using the MBTA who needs help managing their schedules and navigating public transportation, BoT envisions an application that offers a comprehensive solution unlike any other.

Repo Navigation (main structure)

/.idea
/BoT/.idea
/app
--/release
--/src
----/androidTest/java/com/example/bot
----/main
------/java/com/example/bot
--------/activities
--------/data
--------/fragments
--------/network
--------/recylerViewAdapterFiles
--------/viewModel
--------/AlarmNotificationReceiver.kt
--------/ClearPreferences.kt
--------/MbtaApi.kt
--------/PushNotificatoinService.kt
--------/RetrieveCalenderEventsTask.kt
--------/RetrofitInstance.kt
------/res
------/AndroidManifest.xml
------/ic_launcher-playstore.png
----/test/java/com/example/bot
--/.gitignore
--/build.gradle
--/google-services.json
--/proguard-rules.pro
/gradle/wrapper
/node_modules
/.gitignore
/build.gradle
/gradle.properties
/gradlew
/gradlew.bat
/package-lock.json
/settings.gradle

How to run the code

1. Download Android Studio if you haven't had it.
2. Clone the whole repository into your local environment.
3. Open the code with Android Studio.
4. Set up the necessary environment by running build.graddlefile.
5. Build and run /app/src/main/java/com/example/bot/activities/MainActivity.kl file