🖌️ Grimity

그림쟁이들을 위한 그림 커뮤니티, 그리미티에 대한 Flutter 기반의 모바일 애플리케이션입니다.

🔗 관련 종속성

종속성	최소 버전	배포 버전
Flutter SDK	>= 3.44.2	FLUTTER_VERSION

🚀 자동화 배포

자동화 배포를 위한 CI/CD 에서는 Fastlane을 통한 GitHub Actions를 사용합니다.

• 상단 Actions 탭 클릭
• 왼쪽 사이드바에서 All workflows → 자동화 배포 선택
• Run workflow 버튼 클릭
• 배포할 버전 입력 ...(이하 생략)

🗂️ 초기 세팅하기

최상위 경로를 기준으로 터미널에 아래와 같이 입력하세요.

Note

해당 CLI는 앱을 빌드 하는데 필수적인 설정 파일들을 불러오고 build_runner와 같은 Dart 전처리를 수행하는 등의 작업을 수행합니다.

dart run tools/setup.dart

⚙️ 설정 파일 불러오기

최상위 경로를 기준으로 터미널에 아래와 같이 입력하세요.

dart run git_config fetch

🔄 OpenAPI 코드 생성하기

서버의 OpenAPI 명세를 기준으로 API 클라이언트와 요청·응답 모델을 생성합니다. 최상위 경로를 기준으로 터미널에 아래와 같이 입력하세요.

dart run tools/openapi.dart

해당 CLI는 서버 dev 브랜치의 최신 OpenAPI 명세를 불러온 뒤 swagger_parser와 build_runner를 순서대로 실행합니다.

자세한 내용은 프론트엔드 OpenAPI codegen 적용 가이드를 참고하세요.

Warning

lib/data/gen 내부는 자동 생성되는 코드이므로 직접 수정하지 마세요. 서버 API가 변경되면 위 명령어를 다시 실행해야 합니다.

• 생성 설정: swagger_parser.yaml
• 생성 경로: lib/data/gen
• 생성 API 연결 및 응답 변환: lib/data/service, lib/data/mapper
• OpenAPI 범위 밖의 OAuth 및 WebSocket 타입: lib/data/data_source/remote/oauth_api.dart, lib/data/realtime

🔗 XCode 빌드 종속성

XCode를 통한 빌드 과정에서는 FlutterFire CLI가 필수적으로 설치되어 있어야 합니다. 따라서 최상위 경로를 기준으로 터미널에 아래와 같이 입력하세요.

dart pub global activate flutterfire_cli

💻 VSCode 빌드 작업

Visual Studio Code를 사용한다면 프로젝트를 열고 Ctrl + Shift + B를 눌러 build_runner build 작업을 손쉽게 곧바로 실행할 수 있습니다. 이 작업은 Riverpod, Freezed 등의 코드 생성기를 자동으로 감지하고 빌드 합니다.

또는 이를 수동으로 실행하고 싶다면 터미널에 아래와 같이 입력하세요.

dart run build_runner build --delete-conflicting-outputs

🔥 앱 빌드 & 실행

해당 프로젝트는 Flavor를 사용합니다. 따라서 앱을 실행할 때는 환경에 맞는 엔트리포인트와 함께 아래 명령어를 터미널에 입력해야 합니다.

개발 서버

flutter run --profile --flavor dev --target lib/app/entrypoints/main_dev.dart

운영 서버

flutter run --profile --flavor prod --target lib/app/entrypoints/main_prod.dart