Skip to content

Latest commit

 

History

History
184 lines (151 loc) · 6.38 KB

README.md

File metadata and controls

184 lines (151 loc) · 6.38 KB
Raw

Kanade

Experience the thrill and excitement of music with Kanade!
Kanade is an elegant music player app that can display synchronized lyrics.

screenshots

Do you speak Japanese? Japanese READEME is Here!

Status

Ready!! 🚀

After a long development period, we have finally released it to Google Play! However, development is still ongoing and contributions are always welcome. Try building your app by following the section below.

Download from GooglePlay

Why?

I created this as a test of my own skills! It's like a portfolio. I wanted to deepen my knowledge of Android, Kotlin, and Jetpack Compose, and let people know about my capabilities. In addition, I was unsatisfied that existing music player apps could not display lyrics for music stored locally. Even subscription music services like Spotify can display lyrics.

Tech Stack

Feature

Ready!!

  • Music playback function
    • Playback using Media3
    • Reading / Writing from MediaStore
    • MediaStyle Notification
    • Equalizer
    • Editing / Display of synchronized lyrics
    • Playlist creation
    • Home Widget
  • Music information retrieval

Not Ready...

  • Fast forward / Rewind music (in seconds)
  • Music recommendation function
  • Artist recommendation function
  • Overall advertising system

Architecture

This shows the architecture diagram of the app. It has become quite complex, so some modules and dependencies are omitted to give an overview.

%%{
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
  album --> ui
  album --> music
  artist --> ui
  artist --> music
  ui --> design
  ui --> repository
  music --> design
  music --> repository
  repository --> datastore
  datastore --> model
  design --> model
  model --> common
Loading

Contribute

This app uses Gradle's Convention Plugins to standardize the build logic, and all logic is described in a module called build-logic. For more information about this approach, please visit nowinandroid.

If you find any bugs or want to improve a feature, or want to develop a new feature, please write an issue first. Then assign yourself and get to work on development. Pull requests are always welcome 😄

When using the Last.fm API or Musixmatch API, please add the API key to local.properties. By default, it is an empty string. For details, please read 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>.