# futbolin

**Repository Path**: daprchina/futbolin

## Basic Information

- **Project Name**: futbolin
- **Description**: A study project to build a table football competition web app with Jakarta MVC, Quarkus and Dapr
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-19
- **Last Updated**: 2022-02-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![CI build](https://github.com/mthmulders/futbolin/actions/workflows/ci.yml/badge.svg)](https://github.com/mthmulders/futbolin/actions/workflows/ci.yml)
[![SonarCloud quality gate](https://sonarcloud.io/api/project_badges/measure?project=mthmulders_futbolin&metric=alert_status)](https://sonarcloud.io/dashboard?id=mthmulders_futbolin)
[![SonarCloud vulnerability count](https://sonarcloud.io/api/project_badges/measure?project=mthmulders_futbolin&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=mthmulders_futbolin)
[![SonarCloud technical debt](https://sonarcloud.io/api/project_badges/measure?project=mthmulders_futbolin&metric=sqale_index)](https://sonarcloud.io/dashboard?id=mthmulders_futbolin)
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=mthmulders/futbolin)](https://dependabot.com)

# Futbolín
This is Futbolín, a table football competition system.
Futbolín is also the Spanish name of table football.
Why Spanish?
Because one of the inventors of table football was a Spaniard, [Alejandro Finisterre](https://en.wikipedia.org/wiki/Alejandro_Finisterre).

## Documentation
The [docs](docs/) folder contains some documentation on architecture and selected technology.

The [deployment](deployment/) folder contains deployment instructions.

The [local](local/) folder contains some useful scripts to ease local development, such as a **docker-compose.yml** that spins up the required infrastructure components.

## Technology
Selected technology for this project may feel a bit like a hodgepodge.
Since it's a pet project, I took the liberty to select whatever I felt like or whatever I am interested in to learn.
It may or may not make sense :-).

A selection of technologies currently in use or projected for future use:

* Java 11
* Java EE with JSR-371 (MVC)
* RabbitMQ
* Quarkus
* Dapr

## License
Code, documentation, graphics in this repository are licensed under the [Apache License, version 2.0](./LICENSE).