Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Musish/Musish

Apple Music...ish
https://github.com/Musish/Musish

apple apple-music music musickit musickitjs react

Last synced: 2 months ago
JSON representation

Apple Music...ish

Host: GitHub
URL: https://github.com/Musish/Musish
Owner: Musish
License: agpl-3.0
Created: 2018-12-01T18:07:45.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-09-22T17:09:03.000Z (4 months ago)
Last Synced: 2024-10-29T15:34:35.883Z (2 months ago)
Topics: apple, apple-music, music, musickit, musickitjs, react
Language: TypeScript
Homepage: https://musi.sh
Size: 20.1 MB
Stars: 3,066
Watchers: 53
Forks: 223
Open Issues: 173
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome - Musish/Musish - Apple Music...ish (TypeScript)

README

![Musish](https://i.imgur.com/ROMO267.png)

# Musish ([musi.sh](https://musi.sh/))

The unofficial open source Apple Music webapp.

Built with React and Apple's MusicKit JS while utilising the official Apple Music API.
Contains some serverless functions deployed with AWS Lambda to speed up certain functionalities. (Found in [backend](https://github.com/Musish/Musish/tree/master/src/backend)).

[![CircleCI](https://img.shields.io/circleci/project/github/Musish/Musish/master.svg)](https://circleci.com/gh/Musish/Musish) ![Dependencies](https://img.shields.io/david/musish/musish.svg) [![OpenCollective](https://opencollective.com/musish/backers/badge.svg)](https://opencollective.com/musish)

![Musish Browse Page](https://i.imgur.com/TFJyZnu.png)

## Looks neat, how can I contribute?

The Musish project welcomes contributions of all sorts; PRs, issues, feedback, comments, donations, or even just sharing the project would all be infinitely useful to us!

Please do remember to read our contributing guidelines before making a pull request.

We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/musish), and we are extremely thankful for all those who have contributed already:

[![Backers on Open Collective](https://opencollective.com/musish/tiers/backer.svg?avatarHeight=36&width=600)](https://opencollective.com/Musish)

A massive thank you also to our code contributors, who you can see [here](https://github.com/Musish/Musish/graphs/contributors)

## Self hosting

Building [Musi.sh](https://musi.sh/) requires [node](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/lang/en/docs/install/).

#### Running the Musish web app:

##### 1. Generating an Apple Developer Token (JWT):

Musish uses the Apple Music API and therefore you'll need a signed developer token from Apple.

Please reference [Apple's official guide](https://developer.apple.com/documentation/applemusicapi/getting_keys_and_creating_tokens) on generating the keys and an associated token.

##### 2. Environment setup:

Musish requires two environment variables to start. You'll need to enter your Apple Developer token as `APPLE_TOKEN`, and a link to your hosted Musish backend with `BACKEND_URL`.

.env.example:

```txt
APPLE_TOKEN=your_apple_music_token
BACKEND_URL=https://musish.app
```

##### 3. Install dependencies:

```shell
yarn
```

##### 4. Launch Musish:

Start webpack dev server on port 8080:

```shell
yarn start
```

_Or:_

```shell
yarn build
```

This will create a directory called `dist` in the project root, these files can be served from a web server as static content.

#### Running the Musish backend:

We use [Serverless](https://serverless.com) to run our backend on AWS lambdas, however you can choose differently here.

##### Generating a Genius Developer Token:

If you wish to work on the Musish project's serverless backend, you will require a Genius Developer token.

Create a client access token via [Genius' developer portal](https://genius.com/developers).

## Is it safe?

Musish uses official Apple public APIs and libraries to handle authentication. The user is prompted to login directly on a new window under the Apple.com domain. Apple.com returns the user a temporary valid token to allow their browser to make requests to Apple Music data only.

At no point do we request, log, or gain access to information from a user of the site. The user's token is never sent to any server other than Apple's own. At no point do we ever intentionally pass any user information to any server which we control.

Our official build (https://musi.sh/) is powered by Github Pages with an AWS lambda providing both lyrics and artist information, we send no cookies or headers related to your Apple account.

---

Credits:

- Musish logo (headphone icon) provided by zidney from the Noun Project.