README.md

Musicale is a music player for the web. It's built with Svelte, Vite and TypeScript for the best user and dev experience.

Try it on musicale.tk

Features

• Simple and clean UI
• Search music and preview their thumbnail
• Click on a result to play in a snap
• App loads fully offline (with SW) (note results and music playing requires an internet connection)
• Frequency bars with a click (YouTube Music doesn't have this feature)
• Favorite music (with local storage and shuffle option + import/export on settings)

Why don't see any photo?

Because you can see and try by yourself on https://musicale.tk

Why?

Today music players are slow (also on loading) and interrupt you with ads audios if free or let you pay for a premium account.

Musicale is a free and open source alternative to those players and streams music from YouTube Music (through a third party API).

API

The interesting thing about Musicale is that there is no backend and the API it's from Piped (a privacy-friendly alternative YouTube frontend), which is well documented here.

Custom API hosting

While you might still be lucky and use the default Piped APIs, due to stricter policies, most of the time they are currently not accessible and it's really suggested to host your own instance to experience Musicale with no downtime.

To get started, make sure Docker and Docker Compose are available to you.
Clone this repository and cd it:

git clone https://github.com/Bellisario/musicale.git && cd musicale

Setup docker-compose.yml and config/config.properties to your own needs.

Start your custom instance (as a daemon) with:

docker compose up -d

You can now switch to your custom instance on Musicale opening Settings, then Custom instance.

Development

To get started, make sure to have git and bun installed.

Clone the repo and cd it:

git clone https://github.com/Bellisario/musicale.git && cd musicale

Install dependencies:

bun install

Then, you can run the following command to start the server (in DEV mode):

bun run dev

After done, to build the project run:

bun run build

If you want to preview the build run:

bun run preview

Before opening a pull, please make sure to run bun run check to check for warnings, errors, etc. and format your code with VSCode (Svelte extension).

Contributing

We :heart: contributions!
Feel free to open an issue or a pull request but follow Contributing Guidelines.

Tip: if you don't know where to start, check out the help wanted issues!

Legal

We do NOT host or scrape any Youtube Music content, we use a PUBLIC available API to provide user a playable URL of the music through a good-looking interface, WITHOUT violating any laws.

Musicale is NOT affiliated with Piped, YouTube, YouTube Music or Google in any way. All the content played on Musicale is offered by third parties and is NOT hosted by Musicale.

If you suspect a violation of your rights, you should contact the respective third party providers.

Note: Musicale uses Piped as API but servers used may NOT be affiliated with Piped itself.

License

MIT License here.