Skip to content

Latest commit

 

History

History
183 lines (150 loc) · 6.69 KB

README-ja.md

File metadata and controls

183 lines (150 loc) · 6.69 KB

Kanade

Kanadeでワクワクドキドキな音楽体験を！
Kanadeは同期歌詞を表示できるエレガントな音楽プレイヤーアプリです。

screenshots

Status

Ready!! 🚀

長きに渡った開発期間を得て、ついに GooglePlay にリリースしました！ しかし開発は今も継続中で、コントリビュートはいつでも歓迎です。下のセクションに従ってアプリをビルドしてみてください。

Download from GooglePlay

Why?

自分の腕試しのために作りました！言うなればポートフォリオです。Android Kotlin Jetpack Compose の知識を深め、自分の能力を整理するために作成しました。他には、既存の音楽プレイヤーアプリはローカルに保存されている音楽の歌詞を表示できないのが不満でした。Spotifyとかサブスクの音楽は歌詞を表示できるのに...。

Tech Stack

Feature

Ready!!

  • 音楽再生機能
    • Media3を用いた再生
    • MediaStoreからの読み込み / 書き込み
    • MediaStyle Notification
    • Equalizer
    • 同期歌詞の編集 / 表示
    • プレイリストの作成
    • ウィジェット
  • 音楽情報取得

Not Ready...

  • 音楽の早送り / 巻き戻し（秒単位）
  • 音楽おすすめ機能
  • アーティストおすすめ機能
  • 広告系全般

Architecture

アプリのアーキテクチャ図を示します。 だいぶ複雑になっているので、一部のモジュールや依存関係は省略し、概略を掴める形にしています。

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

graph LR
  subgraph gradle 
    build-logic  
  end  
  subgraph application
    app  
  end  
  subgraph core
    common
    datastore
    design
    model
    music
    repository
    ui
  end
  subgraph feature
    album
    artist
    home
    playlist
    song
  end
  app --> album
  app --> artist
  app --> playlist
  app --> song
  app --> home
  home --> ui
  home --> music
  playlist --> ui
  playlist --> music
  song --> ui
  song --> music
  artist --> ui
  artist --> music
  album --> ui
  album --> music
  ui --> design
  ui --> repository
  music --> design
  music --> repository
  repository --> datastore
  datastore --> model
  design --> model
  model --> common
Loading

Contribute

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

何か不具合を発見したり機能を改善したい場合、機能を新たに開発したい場合は、まず issue を書いてください。その上であなた自身を assign し、開発に取り組んでください。pull request はいつでも歓迎です 😄

Last.fm API や Musixmatch API を使用する場合は local.properties にAPIキーを追加してください。デフォルトでは空文字が入っています。詳細は app/build.gradle.kts を読んでください。

License

Kanade
Copyright (C) 2023 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:

    Kanade  Copyright (C) 2023 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>.