Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/musicplayer-io/redditmusicplayer

:musical_note: A free and open-source streaming music web player using data from Reddit
https://github.com/musicplayer-io/redditmusicplayer

coffeescript player reddit soundcloud youtube

Last synced: 3 days ago
JSON representation

:musical_note: A free and open-source streaming music web player using data from Reddit

Awesome Lists containing this project

README

        





music player for reddit





> A free and open-source streaming music web player using data from Reddit.

# Contributing

## Installation from source

```
$ git clone https://github.com/musicplayer-io/redditmusicplayer.git
$ cd redditmusicplayer
$ npm install

$ cp server/config/reddit.coffee.sample server/config/reddit.coffee
# edit server/config/reddit.coffee

$ cp src/coffee/config.coffee.sample src/coffee/config.coffee
# edit src/coffee/config.coffee

// In development
$ npm run build:dev
$ npm start

// In production
$ npm run build
$ NODE_ENV=production npm start

```

## Authentication

You'll need a [Reddit](#reddit) API key for this to work.
As well as a running [redis-server](https://redis.io/topics/quickstart) on port 6379.

## Getting API keys

#### SoundCloud

[SoundCloud API key](https://soundcloud.com/you/apps/new).
Then edit it in `src/coffee/config.coffee`.

#### Reddit

[Get the API key](https://www.reddit.com/prefs/apps/) - Only required for authentication.
You can set an API key for development and production separately in `server/config.reddit.coffee`.

# License

[GPLv3](LICENSE.md) © Ilias Ismanalijev