ocxyz/museeks

A simple, clean and cross-platform music player

museeks

A simple, clean and cross-platform music player. (museeks.io)

It uses:

• Node.js for back-end
• electron (used to be atom-shell) for embedded browser
• React.js as front-end framework and Flux with Redux as data-flow pattern

===

Features

• Lightweight music player
• Polished
• Playlists
• Queue management
• Shuffle, loop
• Dark theme
• Playback speed control
• Sleep mode blocker
• Supported formats:
  • mp3
  • mp4
  • m4a/aac
  • wav
  • ogg
  • 3gpp

===

Releases notes

• Releases notes

===

Installation

Classic

Builds can be found at this page. Please notice those are only portable versions. Installers are on the road.

Build (advanced)

Please consider that master is unstable.

• Download Electron
• Download Museeks source code
• Put it in a folder called app in [Electron path]/resources
• npm install && npm run compile
• Run Electron

===

Bug report

If you want to report a bug, first, thanks a lot. To help us, please indicate your OS, your Museeks version, and how to reproduce it. Adding a screen of the console (Settings -> Advanced -> enable dev mode) is a big help too.

===

Contribute

• Fork and clone
• Master is usually unstable, checkout to a tag to have a stable state of the app
• npm install && npm run dev
• Enable dev mode in the app in the settings view to show DevTools

Webpack will watch for JSX and SASS changes.

Please respect a few rules:

• Before making complex stuff, don't hesitate to open an issue first to discuss about it
• Make the code readable and comment if needed
• Make sure npm run lint passes

Then open a PR :)