🛠 Status: Active Development | Experimental
This project is currently broken and under very active development.
A rewrite of the Resonate tracks api, but with one database to rule them all.
View the product backlog, where work is tracked for this repository.
git clone <repo>
cd <repo>Copy over all the required env variables
cp .env.example .env
cp jwk-keys.json.example jwk-keys.json
cp cookies-keys.json.example cookies-keys.json
Set up the dev environment
yarn install
yarn husky install
And then run the server!
docker-compose up
Migrations should have run as part of docker-compose up
Seed the data
yarn docker:seed:allNow go to http://localhost:4000/docs and you should see the swagger docs!
In short, you need to start the special test container.
yarn docker:compose:test:upLoad in some preliminary test data
yarn docker:seed:all:testAnd then run the tests.
yarn test:allCheck out the test README.md for more details.
We use Standard Style throughout the project. We recommend installing a plugin in whatever your favorite editor is to automatically format code on save, so that you don't have to worry about it. A check will run on any Pull Request that will fail if it's not styled correctly.
We use commitlint to verify that commits are machine and human readable using conventional commits. A check will run on any Pull Request that will fail if it commits are not named correctly.
This API is an API, and as such, it needs clients to be particularly useful!
To register a client, you can simply add one to the database. Check out the client-seeder for what that could look like. For testing purposes you want to take particular note of the meta_data.allowed-cors-origins and redirect_uris. Note that if you are building a browser client and don't match the same origin as in the allowed-cors-origins your requests will fail!
If you're just looking to get started with the API to build your own client, you can use the client in client-seeder.
Note: we should write a thorough guide for that!
Swagger generates docs, you can see them at:
http://localhost:4000/docsIf you want to upload music or upload images, you'll need a worker running.
docker exec -it resonate-api node src/jobs/queue-worker.js runNOTE: this is done automatically by the
resonate-backgroundcontainer in docker.
Hard rebuild the docker container
sudo rm -rf data/ && docker-compose up --buildPoke around the resonate db
docker ps # look for the resonate pgsql container name
docker exec -it <resonate-pgsql-container-name> psql -U resonateTo use Docker on Windows, you will need to have Windows Subsystem for Linux installed. https://docs.docker.com/desktop/install/windows-install/
If you are also working in Visual Studio Code, you may require the Visual Studio Code Remote Development Extension Pack. https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack
This will need to be run to reset the database periodically while migrations are still being squared away.
yarn docker:migrate:undo:all
yarn docker:migrate
yarn docker:seed:allCheck out the src/db/README.md for some common database issues.
The API should just get started if you run
docker-compose up
on your server. However! There are intricacies around SSL and NGINX that are documented in the nginx folder.
Stage is at https://dev.resonate.coop/docs. It's hosted on our Hetzner servers.
Check out the GitHub deploy-stage for how we do it.https://dev.resonate.coop/docs
Prod is at https://prod.resonate.coop/docs. It's hosted on our Hetzner servers.
Right now we manually deploy prod. Check out the nginx readme for production deployment notes.
We use OpenID and the oidc-provider library to provide identity. Check out the documentation in src/auth/README.md