README.md

SNUTT Android

The best timetable application for SNU students, developed and maintained by SNU students.

Features

• Abbreviated course search
• Course search by time slot
• Courses of interest
• Course reviews
• Vacancy notifications
• Friend's timetable
• Custom timetable theme

Tech Stack

• MVVM
• Jetpack Compose
• Dependency Injection with Hilt
• Integration with React Native
• Firebase crashylistics & app distribution

Getting Started

Secrets

The following files are required for Staging build:

• app/src/staging/google-services.json
• app/src/staging/res/value/strings.xml

The following files are required for Live build:

• app/src/live/google-services.json
• app/src/live/res/value/strings.xml

Please request these files from the maintainer if needed.

Installation

1. Install Android Studio.
2. Clone the repository and open the project in Android Studio by entering the following command:

   git clone https://github.com/wafflestudio/snutt-android
   

3. Build and run the project using JDK 17.

Deployment

1. Create a release-${version-code} branch and modify the version code in version.properties.
2. Upload the APK file to the Play Store.
3. Merge the release-${version-code} branch into the develop branch and create a new tag and release for the new version.

Branch Conventions

• The default branch is develop.
• PR branch names should follow the format ${username}/${changes} (e.g., sanggggg/renewal-table-ui).
• Only use squash merge when merging.

Maintainers

• @JuTaK97
• @eastshine2741