Eclypsed / Lazuli

WIP Third Party Client for your favorite music streaming services: Youtube Music, Spotify, Jellyfin, etc.
2 stars 1 forks source link

Any docs on how to deploy ? #2

Open AetherVoyager opened 5 months ago

AetherVoyager commented 5 months ago

Great work, appreciate

Eclypsed commented 5 months ago

Hello @MyJellyfin.

The app is still in development so while there are currently no deployment ready releases, if you want to set up the environment so that you can test and develop it yourself here are some instructions for how to do so:

Firstly, make sure you clone the repository from the latest commit. Much of the Jellyfin functionality was outdated and broken in previous commits. Also, please note that the functionality is still pretty limited and many features are not fully implemented, so don't expect more than basic searching and playback, with very limited UI.

You will need to install the required dependencies and create two files, a lazuli.db in the /src/lib/server directory and a .env file in the root directory. The .env file will need to contain the following values:

The JWT and API keys you can generate yourself.

Additionally, Lazuli relies on Google's YouTube Data API v3 and Google's OAuth 2.0 flow for its YouTube integrations. If you only want to test out its integration with Jellyfin, the above steps should be all you need to follow and you can simply set the PUBLIC_YOUTUBE_API_CLIENT_ID and YOUTUBE_API_CLIENT_SECRET to a null value. However, if you also want to enable YouTube features, you will need to set up a Google Cloud project with YouTube Data API v3 and OAuth 2.0 credentials. Once you have done so you can access your project's Client ID and Client Secret and set those values in the .env file.

I apologize for the arduous process, in the future I plan to create a build script to automate most of the process, as well as create a separate service for handing out YouTube API access tokens so contributors won't need to create their own Google Cloud project. If you have difficulty creating the Google Cloud project I can look into adding additional test users, but for now I am the sole developer.

I hope this helps, if you run into any issues or bugs don't hesitate to reach out. I appreciate your interest in my project!