https://github.com/rayzr522/zstream-server

A music streaming server written from scratch to stream your home library
https://github.com/rayzr522/zstream-server

Last synced: 9 days ago
JSON representation

A music streaming server written from scratch to stream your home library

• Host: GitHub
• URL: https://github.com/rayzr522/zstream-server
• Owner: rayzr522
• License: mit
• Created: 2018-01-18T05:49:49.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-22T00:16:24.000Z (11 months ago)
• Last Synced: 2024-10-12T03:44:42.722Z (25 days ago)
• Language: JavaScript
• Size: 990 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zstream-server

> A music streaming server written from scratch to stream your home library

![Screenshot](res/screenshot.png)

## Installation

If you want a static installation on your system, use the following:

```bash

npm install -g zstream-server

```

If you want a simple one-command solution for installing, updating, and running ZStream:

```bash

npx zstream-server

```

## Usage

To use ZStream, all you have to do is run the `zstream` (or `npx zstream-server`) command while inside a music folder. ZStream will attempt to extract metadata from the song files themselves, but if that fails, it resorts to the folder structure for extrapolating song information. In order for it to correctly identify your music, the folder structure should be as follows:

    root

    ├── Artist 1

    │   ├── Album 1

    │   │   ├── Track 1

    │   │   ├── Track 2

    │   │   ├── Track 3

    │   │   └── ...

    │   └── Album 2

    │       └── ...

    ├── Artist 2

    │   ├── Album 1

    │   └── ...

    └── ...

Then you simply run `zstream` (or `npx zstream-server`) from within the root directory. All music will be automatically loaded and served to `127.0.0.1:3000`.