Skip to content

Commit f8bda2a

Browse files
committed
add README
1 parent 943f41c commit f8bda2a

File tree

5 files changed

+39
-0
lines changed

5 files changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Your Music
2+
## Description
3+
This is a simple music player app which lets you browse and play sound tracks saved on your android device, it provides features like playing music in background, controlling music through notification etc.
4+
This project along with [**GuardianNews**](https://github.com/farbodbj/GuardianNews) were the two projects I have completed as an exercise in the process of my android bootcamp.
5+
6+
## Stack
7+
| Tools | Link |
8+
| :--- | :---: |
9+
| 🤖 Kotlin | [Kotlin](https://kotlinlang.org/) |
10+
| 🎶 Media3 | [Loading & Playing Music](https://developer.android.com/guide/topics/media/media3) |
11+
| 🗝️ Hilt | [DI](https://dagger.dev/hilt/) |
12+
| 🖼️ Glide | [Loading Pictures](https://github.com/bumptech/glide) |
13+
14+
## Design Process
15+
The new [**Jetpack media3**](https://developer.android.com/guide/topics/media/media3) was the core library used in this project. [**MediaStore**](https://developer.android.com/reference/android/provider/MediaStore) was used for providing an real-time access (using Flow api & kotlin coroutines) method to the music files from device storage, [**MediaSessionService**](https://developer.android.com/reference/androidx/media3/session/MediaSessionService) for managing audio playback along with media3 in-built exoplayer and media session. It was tried to keep the design scalable and robust while avoiding unnecessary complications.
16+
17+
## Visuals
18+
19+
<table style="width:100%">
20+
<tr>
21+
<th>music list</th>
22+
<th>single music</th>
23+
<th>permission</th>
24+
</tr>
25+
<tr>
26+
<td><img src = "YourMusic-visuals/MusicList.jpg" width=240/></td>
27+
<td><img src = "YourMusic-visuals/SingleMusic.jpg" width=240/></td>
28+
<td><img src = "YourMusic-visuals/Permission.jpg" width=240/></td>
29+
</tr>
30+
<tr>
31+
<th>notification</th>
32+
</tr>
33+
<tr>
34+
<td><img src = "YourMusic-visuals/Notification.jpg" width=240/></td>
35+
</tr>
36+
</table>
37+
38+
## Contributing
39+
Feel free to contribute to this project by pointing out any bugs, design flaws, updating for best practices or etc using issues or pull requests. I hope this app can be used as a reference for other learners or even be used to actually listen to some quality music :)

YourMusic-visuals/MusicList.jpg

443 KB
Loading

YourMusic-visuals/Notification.jpg

94.8 KB
Loading

YourMusic-visuals/Permission.jpg

128 KB
Loading

YourMusic-visuals/SingleMusic.jpg

211 KB
Loading

0 commit comments

Comments
 (0)