Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build Status Docker Pulls semantic-release

GraphQL API for radio-browser

Check the playground

Deploy to now

Sample query

{
  stations(query: "Electro") {
    url
    name
    tags
  }
}

Stack

Running the npm package

npm i -g radio-gql
radio-gql --port 3000

Running the docker image

docker run -p 3000:3000 ricardocasares/radio-gql

Build from scratch

Clone the repository and inside the root folder run:

docker build . -t radio-gql
docker run -p 3000:3000 radio-gql

You can now visit the playground at http://localhost:3000

Contributing

Feel free to open an issue, pull requests are preferred.

IMPORTANT Make sure you always create new branches from beta.

Automated versioning

We use semantic-release to automate the versioning process, make sure you follow the commit message convention explained here.

HEADS UP: If you are not sure how write a commit message, make your changes in your feature branch and run npm run commit and follow the assistant.

Releases

Beta

Create a feature branch and make a pull-request to beta branch. Once its merged, you can try and install the package using @beta dist tag on npm.

npm i -g radio-gql@beta

Production

Create a new pull-request from beta to master branch. Once it gets merged, the final version will be released using @latest dist tag on npm.