Android Project Template

last updated: 2025/01/26

• build-logic ベースのビルド設定

• Guide to app architecture ベースの MVVM アーキテクチャ

• サンプルコード

• Jetpack Compose

• Dagger Hilt

• Room

• HTTP 通信

  • Retrofit + okhttp
  • OpenAPI Generator

• デバッグメニュー

• Ktlint

• Detekt

• Roborazzi による VRT

• Github Actions ベースの CI

TODO

1. 基本的なアプリの情報を決める

以下を決めて変更作業を実施する。

• アプリ名, applicationId
  • デフォルトでは your.projectPackage になっています。
  • updateAppNames Gradle タスクを実行 して Gradle Project 名とアプリ名、applicationIdの定義とパッケージディレクトリ・パッケージ文を置換します。

./gradlew updateAppNames -PnewName=NewAppName -PnewApplicationId=your.new.package.name

• compileSdk, targetSdk (任意)
  • デフォルトでは 35 になっています。
  • gradle/libs.versions.toml の app-compileSdk, app-compileSdk を編集します。
• minSdk (任意)
  • デフォルトでは 28 になっています。
  • gradle/libs.versions.toml の app-minSdk を編集します。

2. サンプルコードを削除する

delete-samples ブランチをマージ することで サンプルコードを削除できます。

git merge delete-samples

3. README を用意する。

このファイルを削除して、 README.template.md を README.md にリネーム します。

リネーム後 < > で囲まれた箇所などを適宜修正してください。

4. コードオーナー の設定

.github/CODEOWNERS ファイルを追加 し、PR の Approve が必須となる Github ユーザをリストします。

プロジェクト用のチームを作成し、そのチーム名を設定すると管理しやすいのでおすすめです。

参照: https://docs.github.com/ja/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners