Skip to content

Dilatorily/pleochroism

Repository files navigation

Pleochroism

Stories in Ready Build Status codecov

A cross-platform music player made with ❤️

Features

  • Works with all of your music files Available soon!
  • Automatically identifies your song and completes its metadata using MusicBrainz
  • Manages your library and your custom playlists
  • Supports media keys
  • Integrates seamlessly with your OS
  • Scrobbles to Last.fm

Installing Pleochroism

Use the installers for your operating system located here.

Building Pleochroism

Make sure that NPM and Yarn are installed on your system.

  1. Clone the project git clone https://github.com/Dilatorily/pleochroism.git && cd pleochroism.
  2. Install the dependencies using yarn.
  3. Build the application using yarn run build.

It should build the executable for every available platforms.

Developing Pleochroism

To develop Pleochroism, the yarn start command will start an Electron process and a server process located at http://0.0.0.0:8080.

The renderer process will have hot-reloading enabled using React Hot Loader, and the developer console will be available. Devtron, React Developer Tools and Redux DevTools are installed in the developer console.

Contributing

Contributions through pull requests are always welcome, no matter how large or small. Unit tests are appreciated!

This repository is open source and distributed under the MIT License.

Releases

No releases published

Packages

No packages published