mb-arena-service

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 24, 2023 License: MIT Imports: 10 Imported by: 0

README

Mercedes Benz Arena Service

GoDoc Test Status Coverage Status Lint Status CodeQL Status Go Report Card

Spiders the events from the mercedes benz arena in berlin and provides them via API.

Pre-requisites

Execution

You can run the server just with golang.

go run .

Or instead use docker.

docker-compose up

Configuration

The project can be adapted with environment variables. The following variables are available.

Key Default Description
CACHE_UPDATE_CRON 0 2 * * * Event data is cached, this setting describes how often the cache will be updated. The default is set to once a day at 02:00 AM
API_PORT 80 Port on with the API will listen

API Documentation

Provides on GET endpoint on a predefined port and will return a set of events.

[
  {
    "name": "ALBA BERLIN - Armani Mailand",
    "link": "https://www.mercedes-benz-arena-berlin.de/en/events/detail/alba-berlin-armani-mailand/2023-10-26-2000",
    "pictureUrl": "https://www.mercedes-benz-arena-berlin.de/assets/img/ALBA-Mailand-f048ec885a.png",
    "start": "2023-10-26T20:00:00+02:00"
  },
  {
    "name": "Eisbären Berlin - Schwenninger Wild Wings",
    "link": "https://www.mercedes-benz-arena-berlin.de/en/events/detail/eisbaeren-berlin-schwenningen/2023-10-27-1930",
    "pictureUrl": "https://www.mercedes-benz-arena-berlin.de/assets/img/EBB-SWW-20a2dcc8b7.png",
    "start": "2023-10-27T19:30:00+02:00"
  },
  ...
]

Linting

Project used golangci-lint for linting.

Installation

https://golangci-lint.run/usage/install/

Run Linting

Run the linting locally by executing

golangci-lint run ./...

in the working directory

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
app

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL