계단뿌셔클럽 (SCC) 앱

계단뿌셔클럽은 이동 약자를 위한 접근성 정보 등록/공유 플랫폼입니다. 사용자들이 직접 건물과 장소의 접근성 정보를 등록하고 공유할 수 있습니다.

주요 기능

• 건물/장소의 접근성 정보 등록 및 조회
• 접근성 정보 기반 장소 검색
• 접근성 정보 공유 챌린지 참여
• 실시간 접근성 정보 업데이트

시작하기

필수 요구사항

• React Native 개발 환경
• Cocoapods: iOS 라이브러리 관리
• ios-deploy: (선택사항) CLI를 통한 iOS 앱 설치/실행용
• Yarn: 패키지 관리자

설치 방법

1. 저장소 클론

git clone https://github.com/Stair-Crusher-Club/scc-app.git
cd scc-app

2. 서브모듈 초기화

git submodule init
git submodule update

3. 의존성 설치

yarn install
cd ios && pod install && cd ..

4. API 코드 생성

yarn codegen

이 명령어는 subprojects/scc-api/api-spec.yaml OpenAPI 명세를 기반으로 TypeScript API 클라이언트 코드를 생성합니다. API 명세가 변경될 때마다 실행해주세요.

5. Firebase 설정 파일 복사

# 운영 환경 빌드
cp subprojects/scc-frontend-build-configurations/production/google-services.json android/app/src/production/

# 개발 환경 빌드
cp subprojects/scc-frontend-build-configurations/sandbox/google-services.json android/app/src/sandbox/

이 단계는 Android 앱 빌드 전에 필수적으로 수행해야 합니다. Firebase 설정 파일은 빌드 환경별로 다르며, 빌드 프로세스 시작 전에 해당 위치에 있어야 합니다.

6. 개발 서버 실행

yarn start

7. 앱 실행

# iOS
yarn ios

# Android
yarn android

배포

자동 배포 (GitHub Actions)

프로젝트는 GitHub Actions를 통해 자동으로 OTA 업데이트를 배포합니다:

1. 개발 환경 배포

• main 브랜치에 푸시하면 자동으로 개발 환경에 배포됩니다.

2. 운영 환경 배포

• 새로운 버전 태그를 푸시하면 자동으로 운영 환경에 배포됩니다.
• 태그 형식: v<native minor 버전>-<yyyyMMdd>-<두 자리 시퀀스>

# 예시: 네이티브 버전 1.2, 2026년 2월 13일, 첫 번째 배포
git tag v1.2-20260213-01
git push origin v1.2-20260213-01

# 같은 날 두 번째 배포
git tag v1.2-20260213-02
git push origin v1.2-20260213-02

수동 OTA 업데이트

hot-updater를 사용한 수동 OTA 업데이트:

yarn ota-deploy:sandbox -i # 개발 환경
yarn ota-deploy:production -i # 운영 환경

앱스토어/플레이스토어 배포

Fastlane과 GitHub Actions를 사용한 네이티브 빌드 배포:

1. Release 브랜치 생성 (로컬)

release-X.Y.Z 형식의 브랜치를 생성하고 push합니다. 버전 bump는 CI가 브랜치명에서 추출하여 자동 처리합니다.

git checkout -b release-1.3.2
git push origin release-1.3.2

(선택) 로컬에서 미리 버전을 올리고 싶다면 기존 prepare_release도 사용 가능:

cd ios && bundle exec fastlane ios prepare_release version:1.3.2
cd android && bundle exec fastlane android prepare_release version:1.3.2

2. Sandbox 네이티브 빌드 (자동)

release-* 브랜치에 ios/** 또는 android/** 파일이 변경되면 GitHub Actions(cd-native-build.yml)가 자동으로 sandbox 네이티브 빌드를 실행합니다:

• 브랜치명에서 버전을 추출하여 버전 파일이 안 맞으면 자동 bump
• 변경된 플랫폼만 빌드 (iOS/Android path filter 기반)

3. Production 네이티브 빌드 (수동)

GitHub Actions에서 cd-native-build.yml 워크플로우를 **수동 실행(workflow_dispatch)**합니다:

• platform: android 또는 ios 선택
• scheme: production 선택

4. main 머지 → 태그 자동 생성

Release 브랜치를 main에 머지하면, auto-tag-on-merge.yml이 버전 파일에서 버전을 읽어 v1.3.2-ios, v1.3.2-android 태그를 자동 생성합니다 (기록용).

기여하기

프로젝트에 기여하고 싶으시다면 CONTRIBUTING.md를 참고해주세요.

라이선스

이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 LICENSE.md를 참고해주세요.

연락처

문의사항이나 버그 리포트는 GitHub Issues를 통해 제출해주세요.