yumemi-codecheck

GitHub リポジトリ検索アプリ
yumemi-codecheck は 株式会社ゆめみ様の Android エンジニア用コードチェック課題の提出用リポジトリです。

---

Status

Ready!! 🚀

GitHub リリースにて最新のコードおよび APK を配布しています。 また、モバイルアプリ開発者の方はアプリをビルドして、自分でインストールすることもできます。 本アプリは株式会社ゆめみ様のAndroidエンジニア用コードチェック課題を元に開発されており、元リポジトリも併せてご覧ください。

Download from GitHub

Tech Stack

• Kotlin
• Kotlin Coroutines
• Kotlin Flow
• Kotlin Multiplatform
• Jetpack Compose
• Jetpack Compose Multiplatform
• Material3

Environment

• IDE: Android Studio Iguana | 2023.2.1 Patch 1
• Kotlin: 2.0.0-RC03
• Java: 17
• Gradle: 8.3.2
• minSdk: 23
• targetSdk: 34
• compileSdk: 34

※ リリースビルドでの動作確認を行う場合は、local.properties に 以下のように変数を設定してください。

storePassword=yumemi
keyPassword=yumemi
keyAlias=key0

Feature

Ready!!

• リポジトリ
  • リポジトリの検索 (search/repositories)
  • リポジトリの詳細表示 (repos/:owner/:repo)
  • お気に入り機能
• トレンド
  • Weekly のトレンドリポジトリを表示 (alisoft/github-trending-api)
  • トレンドリポジトリの詳細
  • トレンドリポジトリのお気に入り機能
• UI/UX
  • ライトモード / ダークモード
  • ローカライズ（日本語 / 英語）
  • テーマカラーの変更
  • ダイナミックカラーの対応 (Android 12 以上)
  • Foldable, タブレット, デスクトップなどの大画面デバイスへの対応

Not Ready...

• KMP
  • compose-multiplatform を用いた iOS および Desktop への展開

Screenshots

Medium screen

Expanded screen

Architecture

アプリのアーキテクチャ図を示します。 基本的には MVVM + Repository パターンを採用していますが、一部異なる箇所があります。 また、実際はモジュール分割されていませんが、他パッケージとの結合はなく各機能は疎結合です。モジュール分割予定のissueについては #23 をご覧ください。

%%{
init: {
'theme': 'neutral'
}
}%%

graph LR
  subgraph gradle 
    build-logic  
  end  
  subgraph application
    app  
  end  
  subgraph core
    common
    datastore
    model
    repository
    ui
  end
  subgraph feature
    home
    repo
    setting
  end
  app --> home
  app --> repo
  app --> setting
  home --> ui
  home --> repository
  repo --> ui
  repo --> repository
  setting --> ui
  setting --> repository
  ui --> model
  repository --> datastore
  datastore --> model
  model --> common

Loading

Contribute

このアプリは Gradle の Convention Plugins を用いてビルドのロジックを共通化しており、build-logic というモジュールに全てのロジックが記述されています。このアプローチに関しては、nowinandroid をご覧ください。

このアプリは株式会社ゆめみ様のAndroidエンジニア用コードチェック課題であるため、コントリビュートは基本的に受け付けておりません。ただし、バグ報告や機能追加の提案は歓迎いたしますので、Issue を作成してください。

License

yumemi-codecheck
Copyright (C) 2024 daichi-matsumoto

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Also you can contact me by electronic mail at [email protected].

If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

    yumemi-codecheck  Copyright (C) 2024 daichi-matsumoto
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".

You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program
into proprietary programs.  If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library.  If this is what you want to do, use the GNU Lesser General
Public License instead of this License.  But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

オリジナル ReadMe (yumemi-android-engineer-code-check)

株式会社ゆめみ Android エンジニアコードチェック課題

概要

本プロジェクトは株式会社ゆめみ（以下弊社）が、弊社に Android エンジニアを希望する方に出す課題のベースプロジェクトです。本課題が与えられた方は、下記の概要を詳しく読んだ上で課題を取り組んでください。

アプリ仕様

本アプリは GitHub のリポジトリを検索するアプリです。

環境

• IDE：Android Studio Flamingo | 2022.2.1 Patch 2
• Kotlin：1.6.21
• Java：17
• Gradle：8.0
• minSdk：23
• targetSdk：31

※ ライブラリの利用はオープンソースのものに限ります。 ※ 環境は適宜更新してください。

動作

1. 何かしらのキーワードを入力
2. GitHub API（search/repositories）でリポジトリを検索し、結果一覧を概要（リポジトリ名）で表示
3. 特定の結果を選択したら、該当リポジトリの詳細（リポジトリ名、オーナーアイコン、プロジェクト言語、Star 数、Watcher 数、Fork 数、Issue 数）を表示

課題取り組み方法

Issues を確認した上、本プロジェクトを Duplicate してください（Fork しないようにしてください。必要ならプライベートリポジトリにしても大丈夫です）。今後のコミットは全てご自身のリポジトリで行ってください。

コードチェックの課題 Issue は全て 課題 Milestone がついており、難易度に応じて Label が 初級、中級 と ボーナス に分けられています。課題の必須／選択は下記の表とします。

	初級	中級	ボーナス
新卒／未経験者	必須	選択	選択
中途／経験者	必須	必須	選択

課題 Issueをご自身のリポジトリーにコピーするGitHub Actionsをご用意しております。
こちらのWorkflowを手動でトリガーすることでコピーできますのでご活用下さい。

課題が完成したら、リポジトリのアドレスを教えてください。

参考記事

提出された課題の評価ポイントに関しては、こちらの記事に詳しく書かれてありますので、ぜひご覧ください。

AIサービスの利用について

ChatGPTなどAIサービスの利用は禁止しておりません。

利用にあたって工夫したプロンプトやソースコメント等をご提出頂くことで、加点評価する場合もございます。 (減点評価はありません)

また、弊社コードチェック担当者もAIサービスを利用させていただく場合があります。

AIサービスの利用は差し控えてもらいたいなどのご要望がある場合は、お気軽にお申し出ください。