jas-per / rumba-api

interactive api docs for rumba server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rumba-api

Interactive Api documentation for the rum.ba jukebox server. Similar to swagger but a bit more specialized in testing a jukebox and the idiosyncrasies of the Subsonic Api.

api with help text

The whole thing got a bit over the top - there was an older rum.ba webapp that needs porting from react 13/alt.js flux and the idea was to try a new stack on a small project first ;) quite happy with preact hooks and mobx-state-tree - the new rum.ba webapp should be ready later this summer!

api with video player

CLI Commands

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# test the production build at localhost:8080
npm run serve

# run linter
npm run lint

ToDo

integrate response schema for reference as well

About

interactive api docs for rumba server

License:GNU Affero General Public License v3.0


Languages

Language:JavaScript 90.0%Language:CSS 9.1%Language:HTML 0.9%