Skip to content

Server only version of the ruhrpottmetaller system to provide a restful API to store and manage information about concerts and festivals including bands, venues and cities.

License

Notifications You must be signed in to change notification settings

klaus-thorres/ruhrpottmetaller-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ruhrpottmetaller-server

Server only version of the ruhrpottmetaller system to provide a restful API to store and manage information about concerts and festivals including bands, venues and cities.

At the moment only accessing event data is possible. Please do not use this code in production!

This software was created to support the Ruhrpottmetaller project (https://www.ruhrpottmetaller.de).

License

This work is provided under the terms of the MIT license. Please take a look at the LICENSE file for the full text.

Technology

These software versions are known to work:

  • Node.js 12.22
  • MariadDB 10.5

Needed Node.js modules:

  • express 4.17
  • lodash 4.7
  • mysql 2.18

For development:

  • chai 4.3
  • eslint 8.7
  • mocha 9.2

Installation

To install a development environment supporting this project the following steps are necessary:

  • Install Node.js and the node package manager.
  • Clone the project via git clone.
  • Install the dependencies with npm install.
  • Run the App with node index.js.

API Documentation

This section describes the API: Its entry point is /api/v1/. The available endpoints are listed here.

Endpoint event.

This endpoint is used to handle event data.

Get method

By default events which are going to take place today or after today are returned. They are sorted by the ascending date. The number of returned data-sets is limited to 30.

How to contribute

To make a contribution, please clone the project, make your changes and then open a push request or send an e-mail created with git format-patch to the contact address below. Development of ruhrpottmetaller-server-1.0 takes place in the main branch.

If you want to support the development, you can send money via PayPal to https://www.paypal.me/klausthorres or BTC to 13TTodytvT7GebEAfHusb3ug87Sos3W3nk.

Contact

If you have any question, just drop a message at ruhrpottmetaller [at] freenet [dot] de.

About

Server only version of the ruhrpottmetaller system to provide a restful API to store and manage information about concerts and festivals including bands, venues and cities.

Topics

Resources

License

Stars

Watchers

Forks