README.md

About the app

The purpose of this app is to help teens, especially students, with their studies. It contains features that most of the other related apps include but are created from the perspective of a teenager.

The app was created in 2017 and has since been worked on.

Software used

This app uses the following software:

Software	Description	Links
Firebase (Analytics, Authentication, Crashlytics, Cloud Messaging, Firestore)	Firebase is mainly used for the authentication and database backend, as well as cloud notifications and logs events when the app unexpectedly crashes.	Firebase

Libraries used

For more info about the list of libraries used, check out the build.gradle.kts files (root build.gradle.kts, app build.gradle.kts) and the Version Catalog file (gradle/libs.versions.toml.

---

Downloads

Download the latest build here .

Older versions can be accessed here.

The changelog for each version can also be viewed in CHANGELOG.md.

Screenshots

COMING SOON! (Screenshots will be moved to a separate file)

Building the source code

If you would like to build the source code, follow these steps:

1. Clone the project locally by either clicking the Clone or download > Download ZIP or by running the following commands:

   cd path/to/your/desired-location
   git clone https://github.com/EdricChan03/StudyBuddy-android.git

2. Run the following in your terminal:

   macOS/Linux:

   ./gradlew assembleDebug

   Windows:

   gradlew.bat assembleDebug

3. The APK should be signed with the debug key and will be available at app/build/outputs/apk. See Build a debug APK for more info.

Contributing

COMING SOON (There'll soon be a contributing guide - stay tuned!)

Contributors

I would like to thank the following people for their contributions to this project:

Contributor	Reason
@Yasujizr	Creating logo/notification icons