beam desktop/web app repository...
🛠 Status: Active Development | Stable
This project is under active development.
⚠️ ⚠️ The
mainbranch works with api. If you want to fix a bug in the currently live version of Beam, which works with the active id.resonate.coop services, please submit them to the v0.5-maintenance branch.
This is a music player that uses Resonate's API.
This project was bootstrapped with Create React App.
View the project board where work is tracked for this repository.
Install yarn if you don't yet have it on your machine by running:
npx install yarn
git clone email@example.com:resonatecoop/beam.git
Runs the app in the development mode.\ Open http://localhost:8080 to view it in the browser.
The page will reload if you make edits.\ You will also see any lint errors in the console.
Running against the API
The client is set up to run against a locally running version of the API. Check instructions there for how to get it to run. You can also run the client against our stage server (please be nice to it), but for that you'll have to ask us to add a client to the server.
By default, most of the app will work without logging in, but if you want to log in you'll need a
client_secret. Logging in will let you play complete songs, manage your playlists, etc.
First, create a local .env file:
cp .env .env.local
Then, you'll need to set
REACT_APP_CLIENT_SECRET to be the client \
secret for your client app. If you're working on beam directly, \
you can message Si \
to get a client secret.
You can then run that locally with
for unit tests:
for cypress tests:
Set up using this blog post
To try it locally do:
To build it for your system:
Preparing a release
In a distinct commit that just bumps the version.
- Edit the package.json with the new version
git commit -am vx.x.x
git tag vx.x.x
git push && git push --tags