Resonate is an open-source music streaming service run by a cooperative of artists and software developers. If you want to know what we're building, or want to get involved head over to the Platform category on our forum.
Quick-n-dirty instructions to get the player up and running on your computer using http and pointing to the existing production API (see API to learn more about the API). Assumes the latest version of node.js.
Stuck or curious about the roadmap? Ask for help in the forum.
Clone the repo and cd into it:
git@github.com:resonatecoop/stream.git
cd streamInstall lerna. Lerna is a tool that optimizes the workflow around managing multi-package repositories with git and npm.
npm i lerna -gInstall dependencies:
lerna bootstrapCreate your env file:
cp beta/.env.example beta/.envRun the app:
npm run devYou should see the app running at http://localhost:8080.
Try logging in at http://localhost:8080/login.
You can run the app at a different port using the command below:
npm run dev -- -- --port 8089The embed app (optional)
lerna run --scope embed start --parallelHTTPS is required to test PWAs on mobile. Read more about Progressive Web Apps.
You can find a reference nginx configuration file in the docs.
Note that the reference is not a complete nginx.conf file, it should fit within your existing configuration or be wrapped in a http block directive:
http {
server {
}
}
In the example nginx.conf, note the lines referring to the ssl_certificate_key and the ssl_certificate_key.
You can generate a custom certificate using mkcert for beta.resonate.localhost. This origin is whitelisted in our CORS config.
Generate the certificate (cert.pem) and key (key.pem) for beta.resonate.localhost:
mkcert -key-file key.pem -cert-file cert.pem beta.resonate.localhostIn your nginx.conf file, update the ssl_certificate_key and the ssl_certificate_key to refer to your new key and certificate files.
Update your hosts file to include:
127.0.0.1 beta.resonate.localhost
APP_DOMAIN=beta.resonate.localhost
APP_HOST=https://beta.resonate.localhostnpm run devYou should now see the player running on https://beta.resonate.localhost or
If you want to build on the API for personal use, consider checking the backlog in our community forum. The Tracks API repo is currently private, but you may ask for access in the forum.
The Swagger API documentation is currently in flux and split across the Resonate Search API (see the top right corner for the different services) and Resonate Service Documentation: User.
lerna add @resonate/button --scope "beta"Here's how you would add gulp to tools
lerna add gulp --scope toolsnpm run buildTo compile a specific package
lerna run build --scope "@resonate/rangeslider"Run all tests (standard, dependency-check)
npm testTest a specific component
lerna run test --scope "@resonate/player-component"A package can have browser tests (tape-run)
lerna run test:browser --scope "@resonate/api-factory-generator"Commands may be run with $ lerna run.
Example: $ lerna run --scope beta start --parallel.
| Command | Description |
|---|---|
$ npm run dev |
Start beta app development server |
$ npm test |
Lint, validate deps & run dependency-check for all packages |
$ npm run build |
Compile all beta app files into beta/dist/ |
We use standard as a linter and javascript style guide.
Make sure to add appropriate plugin for your editor (see: standard#are-there-text-editor-plugins) or install a pre-commit hook (see .pre-commit-config.yaml) to automatically apply the standard style.
- Augustin Godiscal auggod@resonate.is
- Marie marie@resonate.is
- choo - sturdy 4kb frontend framework
- nanohtml - HTML template strings for the Browser with support for Server Side Rendering in Node. strings
- nanocomponent - create performant HTML components
- tachyons - functional CSS for humans
- sheetify - modular CSS bundler for
browserify