Skip to content

ony-boom/mms

Repository files navigation

MMS - My Music Server

mini demo Demo

Overview

MMS is a web-based local music player that allows you to manage and play your music collection from your browser.

Status: Work in progress, but fully functional for basic music playback.

Installation

Nix/home-manager users

You can use the home-manager module in this repo to install:

# in your flake input
{
    inputs = {
        mms = {
            url = "github:ony-boom/mms";
            inputs.nixpkgs.follows = "nixpkgs";
       };
    };
}

# then somewhere in your config:
{
     services.mms = {
        enable = true;
        # see /nix/modules/home-manager.nix for the other options
    };
}

Note

For other installation methods, I haven't done anything with them yet.s

Manual Installation

  1. Clone the repository:

    git clone https://github.com/ony-boom/mms.git
    cd mms
  2. Install dependencies (requires Node.js ≥ 20 and pnpm):

    pnpm install
  3. Set up the project:

    pnpm run setup
  4. Start the development server:

    pnpm run dev

For more detailed information about the components:

Note

The client should support using other servers, but the server is only compatible with the client. If you want to use the client with another server, you can implement the same API as the server. See apps/client/src/clients/rest for an example.

Roadmap

  • Maybe switch to a desktop application framework (Tauri or Wails are preferred over Electron)
  • Add more advanced music library management features
  • Nix remote binary cache

About

A music server and player

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •