karsake/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

Museeks aims to be a minimalistic and easy to use music player, you will not find tons of features. Here is a little preview though:

• 💻 Cross-platform music player
• ✨ Clean and polished
• 🌟 Playlists
• 🎼 Queue management
• ➰ Shuffle, loop
• 🌄 Covers support
• 🤓 Dark theme
• 🚤 Playback speed control
• 😴 Sleep mode blocker
• 🔊 Minimize to tray
• 🎧 Supported formats: mp3, mp4, m4a/aac, flac, wav, ogg, 3gpp

---

Releases notes

• Over here!

---

Installation

Classic

Builds and installers can be found on this page.

Build (advanced)

Please consider that master is unstable.

• git clone [email protected]:KeitIG/museeks.git
• cd museeks
• npm install
• npm run build or npm run dev
• npm run museeks or npm run museeks:debug

---

Troubleshooting

Museeks is currently in development. This implies some things can break after an update (database schemes changes, config...).

If you encounter freezes when starting the app, you can reset Museeks by following these steps:

• Go to the Museeks folder directory
  • Windows: %AppData%\museeks
  • OSX: ~/Library/Application Support/museeks
  • Linux: ~/.config/museeks/ or $XDG_CONFIG_HOME/museeks
• Delete:
  • IndexedDB folder
  • config.json file
• Restart Museeks

If you still get problems after that, please open an issue :)

---

Bug report

If you want to report a bug, first, thanks a lot, that helps us a lot. Please open an issue and mention 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 then run in a separate terminal npm run museeks:debug
• npm run dev will watch for file changes using Webpack which will recompile JSX and SASS files.

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:sass && npm run lint:js passes

Then open a PR :)