Skip to content

Compiling on Platforms

Jump to bottom
Alexander Frick edited this page Mar 28, 2023 · 1 revision
⚠️ Compiling the application is only for advanced users. Apple Music Electron in a compiled state MAY include issues. If you experience these issues and have not modified the code, open an issue. But any issues originated by your own code, are not our responsibility. Any bugs you do encounter do not reflect the applications state in any way. If you are looking for a stable version download the latest release, but please refrain from using incomplete version bugs as the face of the application. If you experience issues whilst compiling, please refer to the Compiling Support for more information ⚠️

How to compile Apple Music Electron

For most platforms, this is extremely straightforward as it only requires 1 simple CLI command to get it up and running. Run the command associated with your platform below to compile but if that doesn't work continue reading.

Requirements:

  • Node.js (13+ preferably.)
  • Yarn (Not entirely necessary, npm can be used if you prefer)
  • Git (Needed for clone the repository)
  • windows-build-tools (If on Windows. Should be installed with Node.js install but install this if you are having errors saying you do not have Visual Studio or VS19)
  • Simple Command Line Knowledge
  • Code Editor/IDE (optional but recommended if you intend on editing files)

Once you have those items on your machine, enter the command below. If you run into any compilation issues, please create an issue.

Instructions

macOS / Linux Please run the commands below via your terminal: 
git clone --recursive https://github.com/ciderapp/Apple-Music-Electron.git
cd Apple-Music-Electron
yarn install
yarn dist

After you compile your app, it should be in the source directory inside the dist folder.

If using npm only, replace the yarn commands with npm i and npm run dist

Please also note that the macOS build currently will be unable to play Music. This is a result of the application not being signed.

Windows 10/11

Please run the command below via Powershell:

git clone https://github.com/ciderapp/Apple-Music-Electron.git; cd Apple-Music-Electron; yarn; yarn dist;

Some users may have their ExecutionPolicy blocking the previous command. In which case run the following:

git clone https://github.com/ciderapp/Apple-Music-Electron.git; cd Apple-Music-Electron; npx yarn; npx yarn dist;

After you compile your app, it should be in the source directory inside the dist folder.

Clone this wiki locally