kaito-dogi / mybrary Goto Github PK

• MyBookDetail（Public の場合のみ）
  • その人のメモ
  • MyBookDetail に🔗アイコンを設置
• BookDetail
  • その本のメモ
• メモの詳細画面？
• ユーザープロフィール？

• 何をできるようにする？
  • ピン留め
  • お気に入り
  • アーカイブ
  • 可視性変更
• どう表示する？
  • Option Menu
  • TopAppBar

https://firebase.google.com/docs/cloud-messaging

MaterialTheme を使用せず、MybraryTheme で provide する

• Space も Spaces にする？
• UI デザイン的に、Typography を見直す
• shapes のサイズを sm, md, lg のような省略形で選択できるようにする

他にも Android Library である必要がないモジュールは Java or Kotlin Library にする

参考

• 通知チャンネルに対応する

Spring で API を作る
Firestore は NoSQL でキャッシュとして利用する Room と形式が異なるので、使用したくない
DB は MySQL を使用したい

• 削除ではなく公開にするのアリ？
• 削除をどう入れ込むか検討

• Scaffold の中身をどうするか

• グリッド表示用の Item：Cell
• リスト表示用の Item：Row

MyBook と Book のままか、Book と ExternalBook か？

MyBook

@Serializable
data class MyBook(
  val id: MyBookId,
  val externalId: BookId,
  val title: String,
  val imageUrl: Url.Image,
  val isbn10: String,
  val isbn13: String,
  val pageCount: Int, // 必要？
  val authors: List<Author>, // 必要？
  val isPinned: Boolean,
  val isFavorite: Boolean,
  val isArchived: Boolean,
)

Book

@Serializable
data class Book(
  val id: BookId,
  val title: String,
  val imageUrl: Url.Image,
  val isbn10: String,
  val isbn13: String,
  val pageCount: Int, // 必要？
  val authors: List<Author>, // 必要？
)

Author

@Serializable
data class Author(
  val name: String,
)

Note

@Serializable
data class Note(
  val id: NoteId,
  val myBookId: MyBookId, // 必要？
  val content: String,
  val fromPage: Int?,
  val toPage: Int?,
  @Serializable(with = LocalDateTimeSerializer::class)
  val createdAt: LocalDateTime,
  @Serializable(with = LocalDateTimeSerializer::class)
  val editedAt: LocalDateTime?,
  @Serializable(with = LocalDateTimeSerializer::class)
  val postedAt: LocalDateTime?,
  val likeCount: Int?,
)

DraftNote

@Serializable
data class DraftNote(
  val myBookId: MyBookId, // 必要？
  val content: String,
  val fromPage: Int?,
  val toPage: Int?,
)

User

やること

• 開発環境の切り替えを productFlavor で行う
  • dev, prod, mock
  • Debug, Release
• applicationIdSuffix の追加
• isMinifyEnabled の見直し
• applicationId の接尾辞の設定
• アイコンを環境ごとに変える

参考

• https://developer.android.com/build/build-variants?hl=ja#build-types

• 日本語
• 英語

CameraX を使用

参考

• Camera Xライブラリの魅力と最新機能を紐解く

現状

• Repository を data パッケージに置いている
• Impl が、 model で定義した変換メソッドを参照しているので、 data が domain に依存している
  • 具体が抽象に依存すれば良いので、これで問題なさそう？

理想

• interfaces を domain に置き、 impl を data に置くべき？
• data が model に依存しないようにしたい
• domain で usecase を使用して、 usecase で変換すれば良い？

• 親の Scaffold で Snackbar をホストしたい

必要かどうかから検討

アプリの規模が小さいので、シンプルな構成に留めたい
現状の案としては、ui --> domain <-- data となる3モジュールでの構成

Now in Android のように、core, feature で構成

TODO

• 各クラスを internal にする
• 依存関係のバージョン管理

参考

• Clean Architecture の理論と実装

MainActivityにはBottomNavigationのみを置くようにしたい。

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all dependencies (gradle, io.github.jan-tennert.supabase:postgrest-kt, io.github.jan-tennert.supabase:bom, org.jetbrains.kotlinx:kotlinx-serialization-json, com.google.devtools.ksp, org.jetbrains.kotlin.plugin.serialization, org.jetbrains.kotlin.plugin.parcelize, org.jetbrains.kotlin.android, org.jetbrains.kotlin.jvm, com.google.dagger.hilt.android, com.google.dagger:hilt-core, com.google.dagger:hilt-android-compiler, com.google.dagger:hilt-android, io.coil-kt:coil-compose, androidx.test.ext:junit-ktx, androidx.lifecycle:lifecycle-runtime-compose, androidx.test.espresso:espresso-core, com.android.library, com.android.application)

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

• MyBookDetail の BottomAppBar にアイコンを追加
• 可視性を変更したときに Snackbar を表示

https://developer.android.com/build/migrate-to-ksp?hl=ja

• ktlint
• Android Lint

• Profile タブ
• ヘッダーに自分のプロフィール
• 自分のメモのリスト

• 画面遷移時のアニメーション
• BottomSheet, Dialog を composable に含められないか
  • Jetpack Navigation Compose Material
• Snackbar を各画面で持つか

• :core:database:local を作成
• database モジュールから domain の依存を削除する

• kaito_dogi を kaito.dogi にする

• GitHub Actions + GPT-4 TurboでPull Requestのコードレビューを自動化する

TODO

• 既存の UI を Figma に書き起こす
• Figma のリンクを README に貼る

• 機能
  • アーカイブされた本の確認
  • みんなのメモ機能をオフにする
  • ログアウト
  • 本の表示サイズ（優先度低）
• どのような導線にするか…
  • BottomNavigation？
    • Mybrary（Mybrary）
    • Notes, Shared, Shared Notes（みんなのメモ）
    • Profile（プロフィール）
  • TopAppBar？

Retrofit のインスタンスの DI を上手く書けるはずなので、修正する

ある程度リファクタが完了したら README をちゃんと書きたい

項目の案

• Mybrary
  • アプリの概要
• Features
  • 機能の説明
    • スクショ（表で表示）
    • 箇条書き（各スクショの説明）
  • Design / デザイン
    • Figma のリンク
• Architecture / アーキテクチャ
  • アーキテクチャの説明
  • Package Configuration / パッケージ構成
• Tech Stacks / 使用技術
  • 使用技術の説明
• Project Rules / プロジェクトのルール
  • Branch Rules / ブランチ戦略
  • Commit Rulesコミット規則
  • Coding Conventions / コード規約

参考

• Features, Dev Environment, Architecture
  • https://github.com/DroidKaigi/conference-app-2018
• Tech Stacks
  • https://github.com/DroidKaigi/conference-app-2020
  • https://github.com/DroidKaigi/conference-app-2022
• コード規約
  • https://kotlinlang.org/docs/coding-conventions.html