Skip to content

shotaIDE/pochi-trim

BranchesTags

Repository files navigation

開発貢献ガイド

このドキュメントでは、プロジェクトの開発に貢献するための手順を説明します。

開発環境を有効化するためのクイックスタートガイド

Google Cloud と Firebase のプロジェクト新規作成

infra/README.md を参照して、Firebase と Google Cloud のプロジェクトやリソースを構築します。

Firebase プロジェクトの手動設定

Terraform で作成した Firebase プロジェクトに、Firebase Console から手動で以下の設定を行います。

:::message Google アカウントのログインプロバイダを設定する場合、SHA-1 フィンガープリントを登録する必要がある。Firebase Emulator 環境においても同様に登録が必要。 https://developers.google.com/android/guides/client-auth?hl=ja#using_keytool_on_the_certificate :::

Flutter アプリへの Firebase プロジェクト構成の追加

Flutter アプリに Firebase プロジェクトの構成を追加するために、以下の手順を実行します。

client/firebase.json ファイルにおける buildConfigurations の設定項目を充足するため、以下のパターン数実行する必要があります。

  • Emulator/Dev x Debug/Profile/Release の 6 パターン
    • Prod 環境は後から実施する想定

事前準備

Firebase CLI のインストールとログイン、FlutterFire CLI のインストールが必要です。以下を参照してください。

https://firebase.google.com/docs/flutter/setup?hl=ja&platform=ios#install-cli-tools

プロジェクト固有の識別子設定

本ファイル内の以下の識別子を、プロジェクトに合わせて修正してください。

  • Google Cloud のプロジェクト ID のベース部分: flu-fire-base
  • Bundle ID / アプリ ID のベース部分: FlutterFirebaseBase

環境別の設定更新手順

以下の共通変数を設定します：

PROJECT_ID_BASE="colomney"
APPLICATION_ID_BASE="ide.shota.colomney"

各環境ごとに以下の変数を設定し、共通のコマンドを実行します：

Emulator 環境の設定
# 環境固有の変数設定
PROJECT_ID_SUFFIX="-house-worker-dev-tf1"
APPLICATION_ID_SUFFIX=".HouseWorker.emulator"
DART_FILE_NAME_SUFFIX="_emulator"
DIRECTORY_NAME_FOR_IOS="Emulator"
DIRECTORY_NAME_FOR_ANDROID="emulator"
PROJECT_ID="${PROJECT_ID_BASE}${PROJECT_ID_SUFFIX}"
APPLICATION_ID="${APPLICATION_ID_BASE}${APPLICATION_ID_SUFFIX}"

実行時、プロンプトの選択肢では以下を選んでください：

  • "Build configuration"
  • "Debug-emulator"
Dev 環境の設定
# 環境固有の変数設定
PROJECT_ID_SUFFIX="-house-worker-dev-tf1"
APPLICATION_ID_SUFFIX=".HouseWorker.dev"
DART_FILE_NAME_SUFFIX="_dev"
DIRECTORY_NAME_FOR_IOS="Dev"
DIRECTORY_NAME_FOR_ANDROID="dev"
PROJECT_ID="${PROJECT_ID_BASE}${PROJECT_ID_SUFFIX}"
APPLICATION_ID="${APPLICATION_ID_BASE}${APPLICATION_ID_SUFFIX}"

実行時、プロンプトの選択肢では以下を選んでください：

  • "Build configuration"
  • "Debug-dev"
Prod 環境の設定
# 環境固有の変数設定
PROJECT_ID_SUFFIX="-pochi-trim"
APPLICATION_ID_SUFFIX=".PochiTrim"
DART_FILE_NAME_SUFFIX="_prod"
DIRECTORY_NAME_FOR_IOS="Prod"
DIRECTORY_NAME_FOR_ANDROID="prod"
PROJECT_ID="${PROJECT_ID_BASE}${PROJECT_ID_SUFFIX}"
APPLICATION_ID="${APPLICATION_ID_BASE}${APPLICATION_ID_SUFFIX}"
共通のコマンド実行

環境ごとの変数を設定した後、以下の共通コマンドを実行します：

# Firebaseの設定ファイル生成
cd client/
flutterfire config \
  --project="${PROJECT_ID}" \
  --out="lib/firebase_options${DART_FILE_NAME_SUFFIX}.dart" \
  --ios-bundle-id="${APPLICATION_ID}" \
  --ios-out="ios/Runner/Firebase/${DIRECTORY_NAME_FOR_IOS}/GoogleService-Info.plist" \
  --android-package-name="${APPLICATION_ID}" \
  --android-out="android/app/src/${DIRECTORY_NAME_FOR_ANDROID}/google-services.json"

アプリにおけるプロジェクト固有の識別子設定

client/ 配下における識別子を、プロジェクトに合わせて修正してください。

  • Bundle ID / アプリ ID のベース部分: FlutterFirebaseBase
  • Bundle 名 / パッケージ名のベース部分: flutter_firebase_base

Android において、パッケージ名のベース部分を変更した場合、ディレクトリ名も変更してください。

バージョン番号を設定

client/pubspec.yaml の version フィールドを適切に設定します。

App Store Connect の設定

Apple Developer Console で Bundle Identifier とプロビジョニングプロファイルを登録しておきます。 一旦 Xcode でワークスペースファイルを開くことで、各種 Capability が付与された Bundle Identifier が自動で登録されるので、それを利用すると少し楽です。

Dev 環境のプロビジョニングプロファイルを手動で登録します。

Xcode で「Download Manual Profiles」を実行し、マシンに作成したプロビジョニングプロファイルをダウンロードします。

Xcode の TARGET で「Build Settings」タブを開き、以下の項目を設定します。

  • Provisioning Profile: 手動で登録したプロビジョニングプロファイルを選択

client/ios/ExportOptions_dev.plist における以下の項目を手動で修正します。

  • Bundle Identifier（まだ修正していない場合）
  • プロビジョニングプロファイルの名前

App Store Connect にアプリを登録します。

client/ios/fastlane/.env.example を参考に、client/ios/fastlane/.env ファイルを作成し、中身を設定します。

client/ios/fastlane/app-store-connect-api-key.p8 に App Store Connect API キーを配置します。

Dev 環境のデプロイレーンでアップロードします。 ここでは、外部テストへの必要情報が未登録のため、レーンとしては失敗しますが、ビルドのアップロードまでは成功します。

内部テスターと外部テスターのグループを作成します。

Test Flight で外部テストを利用するために、外部テスト用の情報を登録します。 フォーム上必須と表示される情報以外にも、以下の情報が外部テスト審査に必須となっているため、登録しておきます。

  • ベータ版アプリの説明
  • フィードバックメールアドレス

ビルド番号をインクリメントし、再度、Dev 環境のデプロイレーンでアップロードします。

GitHub Actions CD のワークフローを元に、GitHub Actions の Secrets を設定します。

Android のリリースビルドの設定

以下を参考に設定します。

https://docs.flutter.dev/deployment/android#sign-the-app

Google Play Console の設定

Google Play Console でアプリを登録します。

アプリ情報を登録することで、クローズドテストが可能な状態にします。

参照者のロールを持つサービスアカウントを作成し、JSON キーファイルを client/android/fastlane/google-play-service-account-key.json ダウンロードします。

サービスアカウントに対し、Google Play Console で作成したアプリに関する以下の権限を与えます。

  • アプリ情報の閲覧（読み取り専用）
  • 未公開のアプリの編集、削除
  • 製品版としてのリリース、デバイスの除外、Play App Signing の使用
  • テスト版トラックとしてのアプリのリリース
  • ストアでの表示の管理

1 回アプリをクローズドテストトラックに手動でアップロードします。 これにより、アプリに Application ID が紐づけられることにより、fastlane からアプリのアップロードが可能になります。

クローズドテストの公開を審査に提出します。 審査が通ることにより、内部テストに対して fastlane からアップロードし公開までを行うことが可能になります。

Dev 環境のデプロイレーンで動作確認します。

Renovate の設定

GitHub 上で Renovate App をインストールし、リポジトリに対して有効化します。

renovate.json に関して、以下のように設定を変更します。

  • rangeStrategy: pin

GitHub Actions の Secrets の設定

GitHub Actions CI のワークフローを元に、GitHub Actions の Secrets を設定します。

開発環境の追加セットアップ

Firebase プロジェクトの手動設定

  • Google アナリティクスの有効化
  • Remote Config でパラメータを設定

アプリ表示名のセットアップ

プロジェクトファイル内の以下の名前を、プロジェクトに合わせて修正してください。

  • アプリ表示名: Flutter Firebase Base
  • アプリ表示名の短縮版: FluFire Base

アプリアイコンのセットアップ

iOS、Android ともに、flutter_launcher_icons ライブラリを利用して生成します。

Warning

Android でベクター画像を利用する際は、以下の手順では実施できません。 ベクター画像（SVG など）を利用する場合、Android プロジェクトの app/src/main/res/drawable-* フォルダへ手動でアイコンを追加してください。

client/assets/launcher-icon 配下に、アプリアイコンの元画像を配置します。

以下コマンドを実行します。

dart run flutter_launcher_icons

client/ios/Runner.xcodeproj/project.pbxproj における差分を元に戻します。 このファイルは xcconfig ファイルとの組み合わせでアイコン名が既に指定されているため、flutter_launcher_icons による変更は不要なためです。

商用リリース後のセットアップ

商用リリース後は、以下の手順を実施してプロジェクトを更新します。

App Store Connect の設定

App Store Connect からリリース済みのアプリのスクリーンショットやメタデータをダウンロードします。

https://docs.fastlane.tools/actions/upload_to_app_store/

以下のコマンドを実行します。

bundle exec fastlane deliver download_screenshots
bundle exec fastlane deliver download_metadata

Prod 環境のデプロイレーンで動作確認します。

:::message 手動で登録したものと自動で登録されたものでスクリーンショットが重複することがあるため、その場合は手動で削除します。 :::

Google Play Console の設定

サービスアカウントを Google Play Console でアプリに対して必要な権限を与えます。

Google Play Console からリリース済みのアプリのスクリーンショットやメタデータをダウンロードします。

https://docs.fastlane.tools/actions/upload_to_play_store/

以下のコマンドを実行します。

bundle exec fastlane supply init

Prod 環境のデプロイレーンで動作確認します。

開発環境のセットアップ

必要条件

  • Flutter SDK
  • Firebase CLI
  • Android Studio / Xcode（モバイル開発用）

初期プロジェクト設定

以下の設定は、プロジェクトの初期構築時に実施した手順です。通常の開発作業では参照する必要はありません。

Flavor の設定

Flavor を追加する場合は、以下の公式ドキュメントに従ってセットアップしてください。 Xcode 上でスキームの設定を行ってください。また、独自のビルド設定を追加する手順も必要です。

https://docs.flutter.dev/deployment/flavors-ios

ツールのバージョン固定

Xcode のバージョンを強制するには、以下の手順を実行してください。

https://qiita.com/manicmaniac/items/5294dd16cd6f835ab2d9

アイコンの設定

iOS、Android ともに、flutter_launcher_icons ライブラリを利用して生成します。 ライブラリが参照する設定ファイルは、以下の通りです。

以下を参考に設定してください。 コマンド実行後 iOS に適用するには、Xcode の"User-Defined Setting"により、構成ごとのアイコン名を定義し、設定する必要があります。

https://pub.dev/packages/flutter_launcher_icons#2-run-the-package

fastlane の設定

以下を参考に、fastlane を設定します。

https://docs.flutter.dev/deployment/cd#fastlane

RevenueCat の設定

RevenueCat のダッシュボードで、本番環境のアプリを束ねる 1 つのプロジェクトを作成します。

プロジェクト内で App Store と Google Play のアプリを作成します。 以下を参考に必要な設定をストアから取得します。

https://www.revenuecat.com/docs/projects/connect-a-store

プロジェクトにはclient/revenue-cat-config.sample.jsonというサンプルファイルが含まれています。 このファイルをコピーしてclient/revenue-cat-config.jsonを作成してください。

本番環境のアプリをビルドし、App Store と Google Play にそれぞれアップロードします。 課金アイテムを作成するために、アプリのアップロードや審査提出が必要なためです。

以下を参考に課金アイテムを AppStore と Google Play それぞれに作成します。

https://www.revenuecat.com/docs/offerings/products/setup-index

具体的には、以下の手順を実行します。

  1. Entitlement(アプリ内で課金によって解放される資格)を RevenueCat のダッシュボードで作成します。
  2. App Store Connect でアプリを作成し、アプリ専用の課金アイテムを作成し、下書き状態としておきます
  3. Google Play Console でアプリを作成し、アプリ専用の課金アイテムを作成します。
  4. RevenueCat のダッシュボードで、App Store と Google Play で作成した課金アイテムを Product(アプリ内で購入できる単位)としてインポートします。
  5. RevenueCat のダッシュボードで、Entitlement と Product を紐付けます。

:::message 上記だけだとまだ課金処理が実装できないため、調査が必要です。 :::

Firebase emulator の設定

Firebase emulator のサーバーをローカルマシンで実行する

「Firebase CLI をインストールする」を参考に、Firebase CLI をインストールします。

以下コマンドを実行します。

cd infra
firebase emulators:start --import=emulator-data --export-on-exit=emulator-data

上記により、infra/emulator-data/ フォルダーに Firebase Emulator のデータが保持されます。 リセットしたい場合は、フォルダーごと削除してください。

Firebase emulator に向けたクライアントアプリを実行する

プロジェクトにはclient/dart-define_emulator.sample.jsonというサンプルファイルが含まれています。 このファイルをコピーしてclient/dart-define_emulator.jsonを作成してください。 この手順はマシンごとに 1 回だけ必要です。

cp client/dart-define_emulator.sample.json client/dart-define_emulator.json

作成したclient/dart-define_emulator.jsonファイル中のEMULATOR_HOSTの値を変更してください。

注意: dart-define_emulator.jsonは gitignore に設定されており、リポジトリにはコミットされません。各開発者が自分の環境に合わせて設定する必要があります。

次に、VSCode の「実行とデバッグ」パネルから"Emulator-Debug"などの構成を選択して実行してください。 プロジェクトには適切な起動構成が含まれており、自動的に --dart-define-from-file=client/dart-define_emulator.json 引数を使用して設定ファイルを読み込みます。

Dev 環境のクライアントアプリをデバッグ実行する

プロジェクトにはclient/dart-define_dev.sample.jsonというサンプルファイルが含まれています。 このファイルをコピーしてclient/dart-define_dev.jsonを作成してください。 この手順はマシンごとに 1 回だけ必要です。

cp client/dart-define_dev.sample.json client/dart-define_dev.json

各キーの値を実際のものに置き換えてください。

次に、VSCode の「実行とデバッグ」パネルから"Dev-Debug"などの構成を選択して実行してください。

Prod 環境のクライアントアプリをデバッグ実行する

プロジェクトにはclient/dart-define_prod.sample.jsonというサンプルファイルが含まれています。 このファイルをコピーしてclient/dart-define_prod.jsonを作成してください。 この手順はマシンごとに 1 回だけ必要です。

cp client/dart-define_prod.sample.json client/dart-define_prod.json

各キーの値を実際のものに置き換えてください。

次に、VSCode の「実行とデバッグ」パネルから"Prod-Debug"などの構成を選択して実行してください。

デプロイ

App Store へのデプロイ

App Store Connect でアプリを作成します。

また、Apple Developer Console で Bundle Identifier とプロビジョニングプロファイルを登録しておきます。 Xcode で一旦 Automatically Signing により App Store ビルドを Export することで、各種 Capability が付与された Bundle Identifier が自動で登録されるので、それを利用すると少し楽です。 プロビジョニングプロファイルは手動で登録します。

:::message 配布するアプリを Automatically Signing でビルドすると機能が有効化されていないなどのトラブルに見舞われることが多いので、Manual Signing を採用します。 :::

Manual Signing で Export した際に出力された plist を環境ごとに以下のファイルに配置してください：

最後に App Store Connect API キーを発行し、client/ios/fastlane/app-store-connect-api-key.p8 に配置してください。 以下を参考にしてください。

https://docs.fastlane.tools/app-store-connect-api/

fastlane からアップロードして外部テスト公開まで行うには、1 度外部テストに審査を実施して公開しておく必要があります。

Google Play へのデプロイ

以下を参考にして、デプロイ用のサービスアカウントキー(JSON)を用意し、client/android/fastlane/google-play-service-account-key.json に配置してください。

https://docs.fastlane.tools/actions/upload_to_play_store/

fastlane からアップロードするには、1 度手動で Google Play に aab ファイルをアップロードし、内部テスターに公開しておく必要があります。

また、fastlane からアップロードして公開まで行うには、1 度クローズドテストに審査を実施して公開しておく必要があります。

クローズドテストへの審査では、以下のような設定を行います。

  • 広告 ID を分析で利用していると申告

About

No description, website, or topics provided.

Contributing

Contributing
Activity

Stars

1 star

Watchers

0 watching

Forks

1 fork
Report repository

Releases

160 tags

Packages

 
 
 

Contributors

Languages