Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bigbluehat/champ

Personal music streaming server with offline capabilities.
https://github.com/bigbluehat/champ

Last synced: 2 months ago
JSON representation

Personal music streaming server with offline capabilities.

Host: GitHub
URL: https://github.com/bigbluehat/champ
Owner: BigBlueHat
License: mit
Created: 2013-06-06T15:38:05.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2014-03-05T20:32:03.000Z (almost 11 years ago)
Last Synced: 2024-10-04T06:39:00.257Z (3 months ago)
Language: JavaScript
Size: 17.7 MB
Stars: 8
Watchers: 3
Forks: 1
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Champ [![Build Status](https://secure.travis-ci.org/BigBlueHat/champ.png?branch=master)](http://travis-ci.org/BigBlueHat/champ)
(Couch + Amp =) Champ is a personal music streaming server with offline caching capabilities.

## Getting Started
Before you try building a Champ server with your music collection, you
will first want to make sure it's all properly tagged. Currently, Champ
relies on the ability to find [MusicBrainz](http://musicbrainz.org/) properties
on the metadata tags attached to your songs. It is highly recommended that you
download
[MusicBrainz' Picard](http://beta.musicbrainz.org/doc/MusicBrainz_Picard) and
follow the instructions to
[tag your files](http://beta.musicbrainz.org/doc/How_to_Tag_Files_With_Picard).

## Install
```
npm install -g champ
pip install -r requirements.txt
```
*Note*: You will also need Python 2.x or greater installed on your system for
reading the tag information out of your audio files.

## Usage
```

Usage: champ [options] {push, download} uri directory

Commands:
push Create or update a database instance and import all valid
tracks from the supplied directory.
download Fetch all tracks from a database and build a local directory
structure with the file library.

Arguments:
uri Database endpoint location.
directory Root directory of your music folder.

Options:
-h, --help Output usage information.
-q, --quiet Supress output to the console.

```

### Push
Create or update a Champ database with music from your collection.
```
champ push http://localhost:5984/mychamp ~/path/to/my/music/library
```

### Download (Not Yet Implemented)
Download tracks from a database and build a local directory tree from the library.
```
champ download http://localhost:5984/mychamp ~/path/to/my/download/folder
```

## Contributing
Want to help me make this bad boy awesome? Great! Here's the rundown:

* Champ pushes everything through CouchDB.
* The player itself is just a CouchApp.
* Champ uses PouchDB for interfacing with CouchDB from the client.
* Allows for easy client-side caching.

In lieu of a formal styleguide, take care to maintain the existing coding style.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.