Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jensborch/go-foosball

Foosball REST service
https://github.com/jensborch/go-foosball

foosball gin-gonic go golang gorm-orm material-ui mui muiv5 react react-query rest-api sqlite swagger typescript

Last synced: about 1 month ago
JSON representation

Foosball REST service

Host: GitHub
URL: https://github.com/jensborch/go-foosball
Owner: jensborch
License: mit
Created: 2018-02-06T21:51:52.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-12-18T08:25:05.000Z (about 1 month ago)
Last Synced: 2024-12-18T09:29:48.603Z (about 1 month ago)
Topics: foosball, gin-gonic, go, golang, gorm-orm, material-ui, mui, muiv5, react, react-query, rest-api, sqlite, swagger, typescript
Language: Go
Homepage:
Size: 23.9 MB
Stars: 10
Watchers: 4
Forks: 1
Open Issues: 17
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Foosball tournament applications

[![Go CI build](https://github.com/jensborch/go-foosball/actions/workflows/go.yml/badge.svg)](https://github.com/jensborch/go-foosball/actions/workflows/go.yml)
[![JS CI build](https://github.com/jensborch/go-foosball/actions/workflows/js.yml/badge.svg)](https://github.com/jensborch/go-foosball/actions/workflows/js.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/jensborch/go-foosball)](https://goreportcard.com/report/github.com/jensborch/go-foosball)
[![codecov](https://codecov.io/gh/jensborch/go-foosball/branch/master/graph/badge.svg)](https://codecov.io/gh/jensborch/go-foosball)

Go-foosball is an application to manage your foosball tournaments. It supports multiple tournaments, and you can easily add players and tables. Each players receives a rating based on a chess like rating system (Elo).

![Screenshot](screenshot.png)

The application is using a REST service back-end written in Go and a front-end created using TypeScript and React.

## Run

Start the application on MacOS using:

```sh
./go-foosball-darwin
```

or on Linux:

```sh
./go-foosball-linux
```

or on Windows:

```bat
go-foosball.exe
```

The GUI can then be accessed using [http://localhost:8080/]

Use `--help` to list command line options - e.g.:

```sh
./go-foosball-darwin --help
```

This will output:

```txt
Usage of ./go-foosball-darwin:
-db string
the database file (default "foosball.db")
-debug
enable debug
-port uint
the port number (default 8080)
```

## Build

Build the back-end using:

```sh
make build
```

```sh
go build -o go-foosball
```

[Go](https://go.dev/) must be installed.

The front-end will be embed in the back-end executable when build using:

```sh
make client build
```

but back-end and front-end can also run separately. To only build the front-end use:

```sh
cd client
pnpm build
```

To only start the front-end use:

```sh
cd client
pnpm start
```

[Node.js](https://nodejs.org/) version 14 or above and [Yarn](https://yarnpkg.com/) must be installed.

## Test

Test the back-end using:

```sh
make test
```

```sh
go test -cover ./...
```

Test the front-end using:

```sh
cd client
pnpm test
```

## Swagger

```sh
make swagger
```

```sh
$(go env GOPATH)/bin/swag init
```

Swagger can be viewed using [http://localhost:8080/swagger/index.html]