https://github.com/poeschl/brettbutler

A simple, self-hosted webapp which organizes upcoming boardgame events and the players for a game.
https://github.com/poeschl/brettbutler

docker-compose planing self-hosted vue3

Last synced: about 1 month ago
JSON representation

A simple, self-hosted webapp which organizes upcoming boardgame events and the players for a game.

• Host: GitHub
• URL: https://github.com/poeschl/brettbutler
• Owner: Poeschl
• License: apache-2.0
• Created: 2023-04-01T10:41:40.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-28T21:56:14.000Z (4 months ago)
• Last Synced: 2024-08-28T23:04:11.814Z (4 months ago)
• Topics: docker-compose, planing, self-hosted, vue3
• Language: Vue
• Homepage:
• Size: 459 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Brettbutler

![Screenshot](docs/screenshot.png)

Brettbutler is a software to makes it easier for you to plan the next board game event.

Especially when there are several board games and more people than player seats.

## Features

* Manage available games (Number of players, Playtime, Description, Url)

* Create an event an add games to it

* Participates can require on any future event

* Login with just a name

## Setup

For an easy setup, a docker-compose file is provided in the `deploy` folder.

It is just a basic setup with traefik as reverse proxy on `http`.

Depending on the environment a certificate for TLS is recommended.

### Plausible tracking

If configured the application can be monitored with [Plausible](https://plausible.io/).

To enable this set the environment variable `PLAUSIBLE_DOMAIN`

and if you are running on a self-hosted instance `PLAUSIBLE_API_HOST`.

An example is shown in the deploy docker-compose.

## Note

This software will get no versioning and lives on the bloody main branch.

## Development

For development there is a little script in the project root named `start_dev_env.sh`.

Executing it as well as `.gradlew backend:bootRun` (from project root) and `npm run dev` (from the `frontend` folder)

will set up the local environment on http://localhost:8888.