From 4b2c2f4670cfbecc7e7fa80917c227715b48046d Mon Sep 17 00:00:00 2001 From: "niklastasler@gmail.com" Date: Wed, 27 Dec 2023 21:42:38 +0100 Subject: [PATCH] docs: add readme --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..00b1c3f --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# Skat-Counter - Web-App to track your Skat games + +Skat-Counter is a simple Go application i started writing in order to learn about [htmx](https://htmx.org/), [templ](https://github.com/a-h/templ) and [jet](https://github.com/go-jet/jet). For the time being it is kind of experimental and a lot of things like proper error handling and logging are still missing. + +Nevertheless it is in a working state and can be used for testing purposes. +For data storage, SQLite is being used. + +## Features + +- Create Skat-Games + - Creation time + - Did you play online (e.g. Tabletop Simulator) or in person? + - How high is the stake? + - Variable number of players +- Edit games + - Stake & online/in person indicator can be changed at any time +- Delete games + - Unwanted games can be deleted again +- Add/modify & delete rounds + +The features and calculations are designed towards the way that my friends and i play Skat, depending on your rules, it might not be suitable for you. + +## Installation + +### Go Binary + +``` +go install github.com/tarow/skat-counter@latest +``` + +### Docker + +```bash +docker run -v ./data:/app ghcr.io/tarow/skat-counter:latest +``` + +### Docker Compose + +```yaml +version: "3.7" + +services: + skat-counter: + image: ghcr.io/tarow/skat-counter:main + container_name: skat-counter + restart: unless-stopped + ports: + - "8080:8080" + volumes: + - ./data:/app +``` + +## Screenshots + +### Game Overview + +![](screenshots/game_overview.png) + +### Game Details + +![](screenshots/game_details.png) + +### Create Game + +![](screenshots/create_game.png)