Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/u-wave/web
Web client for üWave, the self-hosted collaborative listening platform.
https://github.com/u-wave/web
collaborative-listening collaborative-media-player music react u-wave web-app
Last synced: about 12 hours ago
JSON representation
Web client for üWave, the self-hosted collaborative listening platform.
- Host: GitHub
- URL: https://github.com/u-wave/web
- Owner: u-wave
- License: mit
- Created: 2015-09-12T11:34:22.000Z (over 9 years ago)
- Default Branch: default
- Last Pushed: 2024-10-29T10:29:41.000Z (2 months ago)
- Last Synced: 2024-10-29T11:43:36.120Z (2 months ago)
- Topics: collaborative-listening, collaborative-media-player, music, react, u-wave, web-app
- Language: TypeScript
- Homepage: https://demo.u-wave.net
- Size: 49.9 MB
- Stars: 68
- Watchers: 7
- Forks: 15
- Open Issues: 39
-
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-web
Web client for [üWave][].
[Dependencies](#dependencies) - [Setup](#getting-things-working) -
[Building](#building) - [API](#api) - [License](#license)
## Dependencies
For running in the browser: something modern. The aim is to support ~IE11+ and
other modern browsers (recent Chromes and Firefoxes, at least). If you use
something reasonably recent and üWave doesn't work, [file a bug][]!
The server parts of üWave require Node version >= 18.18.0.
## Getting Things Working
To run the web client, you need an [üWave server][u-wave-core] to connect to.
For development, first install the server:
```bash
git clone https://github.com/u-wave/core u-wave-core
cd u-wave-core
npm install
npm start
```
`npm start` will run the üWave server on port 6042.
Then in a separate terminal do:
```bash
git clone https://github.com/u-wave/web u-wave-web
cd u-wave-web
npm install
npm run dev
```
This will run the web client on port 6041. Visit to use
it!
## Building
There are two main build scripts: one for development, and one for production.
The development script runs a local üWave server and auto-reloads the web client
when you make changes.
```bash
npm run dev
```
When building the üWave web client for use on a server, the production build
should be used instead. It removes costly debugging helpers from the code and
minifies everything as much as possible.
```bash
npm run prod
```
The `prod` script doesn't run a local server. To try out your production build,
you can use the standalone `serve` script:
```bash
npm run serve
```
## API
Please see the README in the [compiled npm package][] for API documentation.
## License
The üWave web client is licensed under the [MIT][] license.
The default [mention sound file][] comes from a [Sonics.io][] pack and is under
the [Sonics.io License][] (archive link).
[üWave]: https://u-wave.net
[u-wave-core]: https://github.com/u-wave/core
[compiled npm package]: ./npm/README.md
[file a bug]: https://github.com/u-wave/web/issues
[MIT]: ./LICENSE
[mention sound file]: ./assets/audio/mention.opus
[Sonics.io]: https://web.archive.org/web/20150905161415/http://www.sonics.io/
[Sonics.io License]: https://web.archive.org/web/20150912030216/http://www.sonics.io/license/