https://github.com/poulastaadas/kyoku
A music streaming application like Spotify with onw database entry over 70 thousand
https://github.com/poulastaadas/kyoku
android-application android-music-player api google-authentication hls jetpack jetpack-compose jwt-authentication kotlin-android ktor-server music-app music-downloader music-player music-streaming passkey server
Last synced: 3 months ago
JSON representation
A music streaming application like Spotify with onw database entry over 70 thousand
- Host: GitHub
- URL: https://github.com/poulastaadas/kyoku
- Owner: POULASTAAdAS
- License: gpl-3.0
- Created: 2023-11-25T16:12:45.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-12-02T16:18:43.000Z (11 months ago)
- Last Synced: 2024-12-02T17:28:52.262Z (11 months ago)
- Topics: android-application, android-music-player, api, google-authentication, hls, jetpack, jetpack-compose, jwt-authentication, kotlin-android, ktor-server, music-app, music-downloader, music-player, music-streaming, passkey, server
- Language: HTML
- Homepage:
- Size: 64.1 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
Kyoku
##
Showcase
---
**Design Link -** [Figma](https://www.figma.com/design/9P5gHYSzu2LtQocpmQ0dBF/Kyoku?node-id=0-1&t=2KhBi5HUyz2zrDJk-1)
---
##
Description
> Kyoku is a music streaming application like Spotify or apple music
> It is using HLS protocol to stream music with a backed build using ktor and the application is build using jetpack compose library.
> With over 70 thousand+ songs to play
##
Preview
### Compact
### Expanded
##
Features
- Supports Every Screen size
- Authentication using google and email
- Auto Sync data with backend on each device
##
Technology
| **Client** | **Server** |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- |
| [Jetpack Compose](https://developer.android.com/jetpack?gad_source=1&gclid=CjwKCAiAzba9BhBhEiwA7glbanDtWkSrUjunIXb3dKY88xH_WZeZrqg99eS59XMENKk_SXU_buOVqRoClmEQAvD_BwE&gclsrc=aw.ds) | [Ktor](https://ktor.io/) |
| [Splash Screen ](https://developer.android.com/develop/ui/views/launch/splash-screen) | [Exposed](https://ktor.io/docs/server-integrate-database.html) |
| [Credentials](https://developer.android.com/identity/sign-in/credential-manager) | [MySQL](https://www.mysql.com/) |
| [WorkManager](https://developer.android.com/topic/libraries/architecture/workmanager) | [Session](https://ktor.io/docs/server-session-auth.html) |
| [Dagger Hilt](https://developer.android.com/training/dependency-injection/hilt-android) | [JWT](https://jwt.io/) |
| [WindowSizeClass](https://developer.android.com/reference/kotlin/androidx/compose/material3/windowsizeclass/WindowSizeClass) | [Jedis](https://github.com/redis/jedis) |
| [Media3](https://developer.android.com/media/media3) | |
| [Navigation](https://developer.android.com/develop/ui/compose/navigation) | |
| [OkHttp](https://square.github.io/okhttp/) | |
| [Paging](https://developer.android.com/topic/libraries/architecture/paging/v3-overview) | |
| [Room](https://developer.android.com/training/data-storage/room) | |
| [Coil](https://coil-kt.github.io/coil/compose/) | |
| Palette | |
##
Installation
### Clone Repo
```sh
git clone https://github.com/POULASTAAdAS/Movie-Browsing-App.git
```
### Docker
Remove .example from file [.env.example](https://github.com/POULASTAAdAS/Kyoku/blob/dev/docker/.env.example)
Add passwrords on file .env
```kotlin
MYSQL_USER_PASSWORD=your_password
MYSQL_PASSWORD=your_password
REDIS_PASSWORD=your_password
```
**Run** [docker-compose.yml](https://github.com/POULASTAAdAS/Kyoku/blob/dev/docker/docker-compose.yml)
```sh
docker-compose start -d
```
### Client
**Setup environment variables on local.properties file of the android app**
```kotlin
BASE_URL="your base url"
CLIENT_ID=abcd
```
**Add SHA1 certificate of the client app(Kyoku). Run this on gradle task**
```sh
signinReport
```
1. Create A Google Cloud Project on [GCP](https://console.cloud.google.com/projectcreate)
2. Create OAuth Creadeintials for android and web [here](https://console.cloud.google.com/apis/credentials)
3. Add the Client Id on local.properties file
### Server
**1. shard-manager**
Remove .example from file [res.json.example](https://github.com/POULASTAAdAS/Kyoku/blob/dev/shard-manager/src/main/resources/res.json.example). Add urls
```json
{
"storage": {
"driverClassName": "com.mysql.cj.jdbc.Driver",
"userJdbcURL": "your jdbc url",
"kyokuJdbcURL": "your jdbc url",
"genreArtistShard": "your jdbc url",
"shardPopularSongUrl": "your jdbc url"
}
}
```
Run [shard-manager](https://github.com/POULASTAAdAS/Kyoku/tree/dev/shard-manager) backed server.
- This will create needed sharded database tables and populate with data
- shard-manager also updates needed data i.e. song , artist etc popularity add new data at 12 am every day. [Code file](https://github.com/POULASTAAdAS/Kyoku/blob/dev/shard-manager/src/main/kotlin/com/poulastaa/kyoku/shardmanager/app/plugins/ScheduleJobs.kt)
**2. kyoku-server**
Remove .example from file [application.conf.example](https://github.com/POULASTAAdAS/Kyoku/blob/dev/kyoku-server/app/src/main/resources/application.conf.example)
- Add all the fields
The databse urls should be same on both [application.conf.example](https://github.com/POULASTAAdAS/Kyoku/blob/dev/kyoku-server/app/src/main/resources/application.conf.example) and [res.json.example](https://github.com/POULASTAAdAS/Kyoku/blob/dev/shard-manager/src/main/resources/res.json.example)
```sh
storage {
driverClassName = "com.mysql.cj.jdbc.Driver"
userJdbcURL = "your jdbc url"
kyokuJdbcURL = your jdbc url"
genreArtistShard = "your jdbc url"
popularShard = "your jdbc url"
}
```
Add Properties as environment variables
```kotlin
BASE_URL= "your base url"
CLIENT_ID="abc"
DEV_EMAIL=
ISSUER=https://accounts.google.com
SENDER_EMAIL=
SENDER_PASSWORD=
```
##
License
Designed and developed by Poulastaa Das.
```xml
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```