Siksha Android

SNU Cafeteria Information Application

Features

• 교내 식당 정보 조회
• 교내 식당 메뉴 조회
• 메뉴 즐겨찾기 등록
• 메뉴 리뷰, 평점, 좋아요
• 커뮤니티(WIP)

Tech Stacks

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

Getting Started

Secrets

Staging 빌드를 위해 다음 파일들이 필요합니다.

• app/src/staging/google-services.json
• app/src/staging/res/values/secrets.xml

Live 빌드를 위해 다음 파일들이 필요합니다.

• app/src/live/google-services.json
• app/src/live/res/values/secrets.xml

필요시 maintainer에게 요청해주세요.

Installation

1. Android Studio를 설치합니다.
2. 다음 명령어를 입력하여 repository를 clone하고, Android Studio로 프로젝트를 엽니다.

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

3. JDK 17으로 프로젝트를 빌드하여 실행합니다.

Deployment

1. develop에 모든 PR을 머지하고 release-${version-code} 브랜치를 생성합니다.
2. version.properties의 version code를 rc를 포함하여 입력하고(e.g. 3.4.0-rc1) 푸쉬하면 cd.yml에 따라 app distribution에 apk가 업로드되며, 테스트를 거치며 rc 버전을 올립니다.
3. 테스트가 완료되면 version code를 정식 버전으로 입력하고 푸쉬합니다. app distribution에 업로드된 apk를 플레이스토어에 등록합니다.
4. release-${version-code} 브랜치를 develop에 머지합니다. 출시된 버전이 가장 최근의 release-${version-code} 브랜치와 동일하도록 유지해주세요.

Branch Conventions

• default branch는 develop입니다.
• PR 브랜치 이름은 ${username}/${changes}(e.g. eastshine2741/add-postlist-screen)으로 합니다.
• 머지 시 squash merge만을 사용합니다.

Maintainers

• @eastshine2741
• @wjshim2003