Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/u-wave/core
The core library driving üWave, the self-hosted collaborative listening platform.
https://github.com/u-wave/core
collaborative-listening collaborative-media-player music self-hosted u-wave
Last synced: about 11 hours ago
JSON representation
The core library driving üWave, the self-hosted collaborative listening platform.
- Host: GitHub
- URL: https://github.com/u-wave/core
- Owner: u-wave
- License: mit
- Created: 2016-01-13T19:55:24.000Z (almost 9 years ago)
- Default Branch: default
- Last Pushed: 2024-10-29T08:37:07.000Z (about 2 months ago)
- Last Synced: 2024-10-29T09:53:02.189Z (about 2 months ago)
- Topics: collaborative-listening, collaborative-media-player, music, self-hosted, u-wave
- Language: JavaScript
- Homepage:
- Size: 1.23 MB
- Stars: 31
- Watchers: 6
- Forks: 12
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# u-wave-core
[Website](https://u-wave.net) - [Server List](https://hub.u-wave.net) -
[](https://discord.gg/8vsdfwS8tm)
The backend server for üWave, the collaborative listening platform.
[Dependencies](#dependencies) - [Development](#development) - [API](#api) -
[License](#license)
## Dependencies
üWave consists of two parts: the server (this repository) and the web client.
The server on its own only provides an HTTP API, so you must also run the web
client to actually use it.
üWave requires a Redis database.
## Usage
üWave comes with an executable file that includes YouTube and SoundCloud
support by default. The server can be configured with environment variables.
You must provide a `YOUTUBE_API_KEY` to use YouTube. SoundCloud works
without API keys.
If you need more configuration options, your only option is to use the Node.js
API of this package, and write your own server entry point. Over time more
options will be made available through the CLI.
```bash
npx u-wave-core
```
Environment Variables:
- `SECRET` - A secret key used for encrypting passwords. Must be a 64-character
hexadecimal string (= 256 bits).
- `PORT` - Port to listen on. Defaults to 6042.
- `SQLITE_PATH` - Path to the database file to use. Defaults to `uwave.sqlite`.
- `REDIS_URL` - URL of the Redis instance to connect to. Defaults to
`redis://localhost:6379/`.
- `YOUTUBE_API_KEY` (optional) - Your YouTube Data API key.
## Development
The server can be run in development mode by:
```bash
git clone https://github.com/u-wave/core u-wave-core
cd u-wave-core
npm install
npm start
```
The development server reads configuration from a `.env` file in the root
of the repository.
```bash
# Database connection URLs.
REDIS_URL=redis://localhost:6379/
SQLITE_PATH=uwave_dev.sqlite
# Enables the YouTube media source if given.
YOUTUBE_API_KEY=your key
```
## API
> You only need to use the API if you are integrating the üWave library with your
> own app.
API documentation is very incomplete and might change a lot before 1.0.0.
Take care!
See the [example/][example] directory for a usage example.
### uw = uwave(options={})
Create and start a üWave server.
**Parameters**
- `sqlite` - Path to the SQLite database file.
- `redis` - A Redis connection URL.
### uw.source(sourcePlugin, options={})
Add a media source plugin. Source plugins can be used to search and import media
from remote sources like YouTube or SoundCloud. Existing source plugins can be
found on npm with the [u-wave-source keyword][].
**Parameters**
* `sourcePlugin` - Source plugin or plugin factory. Receives two parameters:
The `uw` üWave Core instance, and the plugin options.
* `options` - Options to pass to the source plugin.
### uw.close(): Promise
Stops the üWave server.
## License
[MIT][]
[IORedis]: https://github.com/luin/ioredis
[u-wave-source keyword]: https://www.npmjs.com/browse/keyword/u-wave-source
[example]: example/
[MIT]: ./LICENSE