Giter Club home page Giter Club logo

timetrials-webservice's Introduction

Time Trials Webservice

This application is a Spring Boot based webservice that provides a REST API to save and query times driven in Mario Kart 8 Deluxe Time Trials.

This service uses Kafka to consume new times and to publish new records when the record for a track is broken.

A MongoDB database is being used to store the data.

Build

This application is set up to be run with Docker. The Dockerfile will start the service by running the services jar. Therefore, the jar has to be created first by running mvn package.

In order to test the application in a full dev environment, Docker Compose can be used. The full environment is defined in compose.yaml and can be started by running docker compose up.

Swagger UI

This project features a Swagger/ OpenAPI documentation.

It is available through the Swagger-UI at /swagger-ui/index.html.

Configuration

The webservice can be configured through environment variables. The following table shows the different variables that can be set.

Environment variable name Description
MONGODB_URI fully specified URI of the database
CONSUMER_GROUP group id for the Kafka consumer
BOOTSTRAP_SERVERS list of Kafka servers to connect to
NEW_TIME_TOPIC name of the Kafka topic which is used for incoming new times
PUBLISH_NEW_RECORD_TOPIC name of the Kafka topic which is used for outgoing times which break the record for their track

timetrials-webservice's People

Contributors

h-rusch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.