readmeの記載とリリース対応

.editorconfig

@@ -0,0 +1,4 @@
+[*.{kt,kts}]
+ktlint_standard_package-name = disabled
+ktlint_function_naming_ignore_when_annotated_with = Composable
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+## 概要
+
+このセクションでは、このPRの目的と概要を簡潔に説明してください。
+
+## 関連Issue
+
+このセクションでは、このPRが関連するIssueやタスクをリンクしてください。以下のように記述します。
+
+- 関連Issue: #123
+
+## 変更点
+
+このセクションでは、具体的な変更点や修正箇所を箇条書きでリストアップしてください。
+
+- 変更点1
+- 変更点2
+- 変更点3
+
+## テスト
+
+このセクションでは、このPRに関連するテストケースやテスト方法を記載してください。
+
+- テストケース1
+- テストケース2
+- テストケース3
+
+

.github/workflows/check_workflow.yaml

@@ -0,0 +1,43 @@
+name: Run Gradle on PRs
+on: pull_request
+jobs:
+  ktlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Change Permission
+        run: chmod +x ./gradlew
+
+      - name: Execute Ktlint Check
+        run: ./gradlew ktlintCheck
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Change Permission
+        run: chmod +x ./gradlew
+
+      - name: Execute Unit Tests
+        run: ./gradlew test jacocoTestReport
+
+      - name: Upload Test Results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results
+          path: app/build/test-results
+
+      - name: Upload Coverage Report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: app/build/reports/tests/testDebugUnitTest/

README.md

@@ -2,58 +2,131 @@
 
 ## 概要
 
-本プロジェクトは株式会社ゆめみ（以下弊社）が、弊社に Android エンジニアを希望する方に出す課題のベースプロジェクトです。本課題が与えられた方は、下記の概要を詳しく読んだ上で課題を取り組んでください。
+このプロジェクトは、GitHubリポジトリの検索と表示を行うAndroidアプリケーションです。Jetpack Composeを使用してUIを構築し、Hiltを使用して依存性注入を行っています。
 
 ## アプリ仕様
 
 本アプリは GitHub のリポジトリを検索するアプリです。
 
 <img src="docs/app.gif" width="320">
 
+## ディレクトリ構成
+```bash
+.
+├── .editorconfig
+├── .github/
+│   ├── PULL_REQUEST_TEMPLATE.md
+│   └── workflows/
+├── .gitignore
+├── .gradle/
+├── .idea/
+├── .kotlin/
+├── app/
+│   ├── src/
+│   │   ├── main/
+│   │   │   ├── java/
+│   │   │   ├── kotlin/
+│   │   │   └── res/
+│   │   └── test/
+│   └── build.gradle
+├── build.gradle
+├── docs/
+├── gradle/
+├── gradle.properties
+├── gradlew
+├── gradlew.bat
+├── LICENSE
+├── local.properties
+├── README.md
+└── settings.gradle
+```
+
 ### 環境
 
-- IDE：Android Studio Flamingo | 2022.2.1 Patch 2
-- Kotlin：1.6.21
+- IDE：Android Studio Ladybug | 2024.2.1 Patch 3
+- Kotlin： 2.0.21
 - Java：17
-- Gradle：8.0
+- Gradle：8.9
 - minSdk：23
-- targetSdk：31
+- targetSdk：35
 
 ※ ライブラリの利用はオープンソースのものに限ります。
 ※ 環境は適宜更新してください。
 
+### linterについて
+
+このプロジェクトはktlintを用いて静的コード解析を行なっている。
+
+ルールとして、パッケージ名に"_"を使うのは許可するものとしている。
+理由としては、コーディングテストのパッケージ名が変わってしまうとアプリとして別物となってしまい、
+リファクタリングの趣旨としてそぐわないと判断したため
+
+コードは以下の二つがある適宜PRを出す前にチェックをすること。
+```bash
+# 自動でフォーマットをかける
+ ./gradlew ktlintFormat
+
+# コードのルール違反をチェックする
+./gradlew ktlintCheck 
+```
+
+### Unitテストについて
+
+- Hilt, JUnit, Mockitoを持ちいてUnitテストを作成しました。
+
+```bash
+# 全件実行をする方法
+./gradlew test jacocoTestReport
+
+# 単体で動かす方法
+./gradlew :app:testDebugUnitTest --tests "jp.co.yumemi.android.code_check.features.github.GitHubServiceRepositoryImplTest"
+```
+
+レポートの保存場所
+以下のパスにWeb表示ができるレポートが格納されます。
+`app/build/reports/tests/testDebugUnitTest/`
+
 ### 動作
 
 1. 何かしらのキーワードを入力
 2. GitHub API（`search/repositories`）でリポジトリを検索し、結果一覧を概要（リポジトリ名）で表示
 3. 特定の結果を選択したら、該当リポジトリの詳細（リポジトリ名、オーナーアイコン、プロジェクト言語、Star 数、Watcher 数、Fork 数、Issue 数）を表示
 
-## 課題取り組み方法
-
-Issues を確認した上、本プロジェクトを [**Duplicate** してください](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/duplicating-a-repository)（Fork しないようにしてください。必要ならプライベートリポジトリにしても大丈夫です）。今後のコミットは全てご自身のリポジトリで行ってください。
 
-コードチェックの課題 Issue は全て [`課題`](https://github.com/yumemi-inc/android-engineer-codecheck/milestone/1) Milestone がついており、難易度に応じて Label が [`初級`](https://github.com/yumemi-inc/android-engineer-codecheck/issues?q=is%3Aopen+is%3Aissue+label%3A初級+milestone%3A課題)、[`中級`](https://github.com/yumemi-inc/android-engineer-codecheck/issues?q=is%3Aopen+is%3Aissue+label%3A中級+milestone%3A課題+) と [`ボーナス`](https://github.com/yumemi-inc/android-engineer-codecheck/issues?q=is%3Aopen+is%3Aissue+label%3Aボーナス+milestone%3A課題+) に分けられています。課題の必須／選択は下記の表とします。
+### 依存関係
 
-|   | 初級 | 中級 | ボーナス
-|--:|:--:|:--:|:--:|
-| 新卒／未経験者 | 必須 | 選択 | 選択 |
-| 中途／経験者 | 必須 | 必須 | 選択 |
+主要な依存関係は以下の通りです。
 
-課題 Issueをご自身のリポジトリーにコピーするGitHub Actionsをご用意しております。  
-[こちらのWorkflow](./.github/workflows/copy-issues.yml)を[手動でトリガーする](https://docs.github.com/ja/actions/managing-workflow-runs/manually-running-a-workflow)ことでコピーできますのでご活用下さい。
+- Jetpack Compose
+- Hilt
+- Retrofit
+- Moshi
+- Coil
 
-課題が完成したら、リポジトリのアドレスを教えてください。
+依存関係の詳細は、`app/build.gradle` ファイルを参照してください。
 
-## 参考記事
+### 重要なファイルとディレクトリ
 
-提出された課題の評価ポイントに関しては、[こちらの記事](https://qiita.com/blendthink/items/aa70b8b3106fb4e3555f)に詳しく書かれてありますので、ぜひご覧ください。
+app/src/main/java - Javaソースコード
+kotlin - Kotlinソースコード
+res - リソースファイル（レイアウト、文字列、画像など）
+test - ユニットテスト
+androidTest - インストルメンテーションテスト
+build.gradle - モジュールのビルド設定
+gradle.properties - プロジェクト全体のプロパティ設定
 
-## AIサービスの利用について
+### トラブルシューティング
 
-ChatGPTなどAIサービスの利用は禁止しておりません。
+- ビルドエラーが発生する場合:
+  - 依存関係が正しくインストールされているか確認してください。
+  - キャッシュをクリアして再ビルドを試みてください。
 
-利用にあたって工夫したプロンプトやソースコメント等をご提出頂くことで、加点評価する場合もございます。 (減点評価はありません)
+```bash
+./gradlew clean
+./gradlew build
+```
 
-また、弊社コードチェック担当者もAIサービスを利用させていただく場合があります。
+- テストが失敗する場合:
+  - テストコードが最新の実装に対応しているか確認してください。
+  - 必要に応じてモックデータを更新してください。
 
-AIサービスの利用は差し控えてもらいたいなどのご要望がある場合は、お気軽にお申し出ください。

app/build.gradle

@@ -4,16 +4,20 @@ plugins {
     id 'kotlin-kapt'
     id 'kotlin-parcelize'
     id 'androidx.navigation.safeargs.kotlin'
+    id("org.jlleitschuh.gradle.ktlint") version "12.1.2"
+    id 'com.google.dagger.hilt.android'
+    id 'jacoco'
+    id("org.jetbrains.kotlin.plugin.compose") version "2.1.0"
 }
 
 android {
     namespace 'jp.co.yumemi.android.code_check'
-    compileSdk 31
+    compileSdk 35
 
     defaultConfig {
         applicationId "jp.co.yumemi.android.codecheck"
         minSdk 23
-        targetSdk 31
+        targetSdk 35
         versionCode 1
         versionName "1.0"
 
@@ -27,38 +31,100 @@ android {
         }
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_11
-        targetCompatibility JavaVersion.VERSION_11
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
     }
     kotlinOptions {
-        jvmTarget = '11'
+        jvmTarget = '1.8'
     }
     buildFeatures {
         viewBinding true
+        buildConfig true
+        compose true
+    }
+    composeOptions {
+        kotlinCompilerExtensionVersion '1.5.0' 
     }
 }
 
 dependencies {
 
-    implementation 'androidx.core:core-ktx:1.6.0'
-    implementation 'androidx.appcompat:appcompat:1.3.1'
-    implementation 'com.google.android.material:material:1.4.0'
-    implementation 'androidx.constraintlayout:constraintlayout:2.1.1'
-    implementation 'androidx.recyclerview:recyclerview:1.2.1'
+    implementation 'androidx.core:core-ktx:1.15.0'
+    implementation 'androidx.appcompat:appcompat:1.7.0'
+    implementation 'com.google.android.material:material:1.12.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.2.0'
+    implementation 'androidx.recyclerview:recyclerview:1.4.0'
 
-    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.5.1'
-    implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.5.1'
-    implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.5.1'
+    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.8.7'
+    implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.8.7'
+    implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.8.7'
 
-    implementation 'androidx.navigation:navigation-fragment-ktx:2.5.3'
-    implementation 'androidx.navigation:navigation-ui-ktx:2.5.3'
+    implementation 'androidx.navigation:navigation-fragment-ktx:2.8.5'
+    implementation 'androidx.navigation:navigation-ui-ktx:2.8.5'
 
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.1'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.8.1'
     implementation 'io.ktor:ktor-client-android:1.6.4'
 
-    implementation 'io.coil-kt:coil:1.3.2'
+    implementation 'io.coil-kt:coil:2.7.0'
 
     testImplementation 'junit:junit:4.13.2'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
+    androidTestImplementation 'androidx.test.ext:junit:1.2.1'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
+    implementation "com.google.dagger:hilt-android:2.55"
+    kapt "com.google.dagger:hilt-compiler:2.55"
+    testImplementation "org.mockito:mockito-core:5.2.0"
+    testImplementation 'org.mockito:mockito-inline:5.2.0'
+    implementation 'androidx.hilt:hilt-navigation-compose:1.2.0'
+
+
+    // Retrofit
+    implementation("com.squareup.retrofit2:converter-moshi:2.9.0")
+    implementation("com.squareup.okhttp3:logging-interceptor:4.12.0")
+    implementation("com.squareup.retrofit2:retrofit:2.11.0")
+    implementation("com.squareup.moshi:moshi-kotlin:1.14.0")
+
+    // jetpack compose
+    def composeBom = platform('androidx.compose:compose-bom:2025.01.00')
+    implementation composeBom
+    androidTestImplementation composeBom
+    implementation 'androidx.compose.material3:material3'
+    implementation 'androidx.compose.foundation:foundation'
+    implementation 'androidx.compose.ui:ui'
+    implementation 'androidx.compose.ui:ui-tooling-preview'
+    debugImplementation 'androidx.compose.ui:ui-tooling'
+    implementation 'androidx.activity:activity-compose:1.10.0'
+    implementation 'androidx.navigation:navigation-compose:2.8.5'
+    implementation "io.coil-kt:coil-compose:2.4.0"
+    implementation "androidx.compose.material:material-icons-extended:1.7.6"
+
+}
+
+kapt {
+    correctErrorTypes true
+}
+
+jacoco {
+    toolVersion = "0.8.8"
+}
+
+tasks.register("jacocoTestReport", JacocoReport) {
+    dependsOn(tasks.test)
+
+    reports {
+        xml.required.set(true)
+        html.required.set(true)
+    }
+
+    def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*Test*.*']
+    def debugTree = fileTree(dir: "$buildDir/intermediates/javac/debug", excludes: fileFilter)
+    def mainSrc = "$projectDir/src/main/java"
+
+    sourceDirectories.setFrom(files([
+        mainSrc,
+        "$projectDir/src/main/kotlin"
+    ]))
+    executionData.setFrom(fileTree(dir: "$buildDir", includes: [
+            "jacoco/testDebugUnitTest.exec",
+            "outputs/code-coverage/connected/*coverage.ec"
+    ]))
 }

app/src/androidTest/kotlin/jp/co/yumemi/android/code_check/ExampleInstrumentedTest.kt

@@ -1,13 +1,11 @@
 package jp.co.yumemi.android.code_check
 
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
-
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.assertEquals
 import org.junit.Test
 import org.junit.runner.RunWith
 
-import org.junit.Assert.*
-
 /**
  * Instrumented test, which will execute on an Android device.
  *
@@ -21,4 +19,4 @@ class ExampleInstrumentedTest {
         val appContext = InstrumentationRegistry.getInstrumentation().targetContext
         assertEquals("jp.co.yumemi.android.codecheck", appContext.packageName)
     }
-}
+}