Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Latest commit

 

History

History
59 lines (38 loc) · 2.06 KB

README.md

File metadata and controls

59 lines (38 loc) · 2.06 KB

Internet Drum Pattern Queue Service

A web service for ingesting and serving internet drum patterns.

This web API is an implementation of the Internet Drum Pattern Queue Service Specification.

Build status

Build Status codecov Docker Pulls

Documentation website

You can view the API documentation online.

How to build

You can build the service locally.

Requirements

To build the service locally, you will need:

Maven needs to use a Java version of 10 or higher. You can check which one it uses by running mvn -v.

Building

Start the build by running the following command at the root of the project:

mvn package

How to run

You can run the web service from the source directory of the com.internetofdrums.api.web module and then using the Exec Maven Plugin:

cd com.internetofdrums.api.web
mvn exec:exec

The web service should then be running at https://localhost:8080/, which should return a 404.

You can then use the service as defined in the specification.