go-foosball

command module
v0.9.0 Latest Latest
Warning

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

Go to latest
Published: Oct 11, 2022 License: MIT Imports: 18 Imported by: 0

README

Foosball tournament applications

Go CI build JS CI build Go Report Card codecov

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

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

Build

Build the back-end using:

make build

or

go build -o go-foosball

Go must be installed.

Build the front-end using:

make client

or

cd client
yarn build

Node.js version 14 or above and Yarn must be installed.

Test

Test the back-end using:

make test

or

go test -cover ./...

Test the front-end using:

cd client
yarn test

Run

Start the application using:

./go-foosball

or on Windows:

go-foosball.exe

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

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

make client build

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

cd client
yarn start

Swagger

make swagger

or

$(go env GOPATH)/bin/swag init

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag

Jump to

Keyboard shortcuts

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