Skip to content

melodee-project/meloamp

Repository files navigation

MeloAmp

MeloAmp Logo

MeloAmp is a modern, cross-platform streaming client for the Melodee music API. Built with React, Material-UI, and Electron, MeloAmp delivers a beautiful, responsive, and customizable music experience for Linux, Windows, and macOS.

It Really Whips the Llama's A**


Features

  • 🎵 Stream music from your Melodee server
  • 🖼️ Browse by Artist, Album, Song, Playlist
  • 📝 Playback queue with drag-and-drop, shuffle, and save as playlist
  • Favorite/unfavorite songs directly from the player
  • 🎚️ Equalizer with persistent user settings
  • 🌈 Modern UI with multiple color themes (light/dark/classic/ocean/forest/sunset)
  • 🔒 JWT authentication
  • 📦 Cross-platform builds (AppImage, DEB, RPM, Snap, Pacman, tar.gz)
  • Scrobbling, scrobbling of play and play complete activity
  • 🖥️ Electron desktop app with native menus and notifications
  • 🛠️ Accessible and keyboard-friendly

Screenshots

Add screenshots here to showcase the UI


Getting Started

Prerequisites

  • Node.js (v18+ recommended)
  • npm
  • Electron
  • Linux: For packaging, install libxcrypt-compat:
    • Ubuntu/Debian: sudo apt-get install -y libxcrypt-compat
    • Fedora: sudo dnf install libxcrypt-compat
    • Arch: sudo pacman -S libxcrypt-compat

Build & Run (Development)

# 1. Build the React UI
cd src/ui
npm install
npm run build

# 2. Start the Electron app
cd ../electron
npm install
npm start

When running the AppImage on Fedora you might need to tell it which GTK to use

./meloamp*.AppImage --gtk-version=3

Build for Linux (Production)

./scripts/build-linux.sh
  • Packages will be output to src/electron/dist/
  • Requires electron-builder (installed automatically by the script)

Configuration

  • API URL: Set your Melodee API endpoint in the app or via environment variables.
  • User settings (theme, equalizer, etc.) are stored in localStorage and can be managed in the app settings.

Contributing

Contributions are welcome! Please:

  • Open issues for bugs or feature requests
  • Fork and submit pull requests
  • Follow the Contributor Covenant

License

This project is licensed under the ISC License.


Credits


Contact

For support or questions, contact info@melodee.org.

About

Cross platform streaming client for Melodee

Resources

License

Stars

Watchers

Forks

Releases

No releases published