riomoo/gofudge
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages 1 Wiki Activity Actions

Correct Build instructions (#3)

Browse source 
Reviewed-on: #3
Co-authored-by: riomoo <alister@kamikishi.net>
Co-committed-by: riomoo <alister@kamikishi.net>
This commit is contained in:
riomoo 2026-01-13 09:38:46 -05:00 • committed by moobot
parent 62daab494a
commit 5941b1ae33
Signed by: moobot
GPG key ID: 1F58B1369E1C199C
1 changed files with 18 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -9,22 +9,30 @@ A Fudge Dice rolling room programmed in Go
## Prerequisites
[![Go](https://img.shields.io/badge/go-%2300ADD8.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/dl/)
- The version of **Go** used to test the code in this repository is **1.25.3**.
- Go 1.25.3+ (only needed to build)
- Or just download a pre-built binary from Releases (when available)
## Get started
- run the following commands: `go mod tidy; go build -o bin/main ./app/gofudge/main.go` then `./bin/main` to start the server on port 8080.
### Quick start (from source)
```bash
git clone https://codeberg.org/riomoo/gofudge.git
cd gofudge
go build -o gofudge app/gofudge/main.go
./gofudge
```
- Visit http://localhost:8080 in your browser.
- Upon visiting the URL you will be created with a username entry and Create room button. After that you will be in the room.
- (If you are hosting this publicly) You can copy the room link in the top right hand corner and share it to anyone. They will be prompted to also pick a username.
- From there you may increase/decrease the modifier as needed for the skill you are rolling for.
### Podman/Docker
- If you want to use this with Docker, replace all `podman` commands in `run.sh` instances with `docker`
- Use `run.sh` script which will start the site on port `12007` and to make it public change the `8080` port in the NGINX config to `12007` or change the port in the `run.sh` script how you like.
- To use it locally, same as above but visit http://localhost:12007 instead.
## If you want to use this with podman:
```bash
git clone https://codeberg.org/riomoo/gofudge.git
cd gofudge
./scripts-bash/run.sh
```
Then open http://localhost:12007 in your browser.
## Config for NGINX to use as a website:
```
@ -101,6 +109,7 @@ server {
## Software Used but not included
![Arch](https://img.shields.io/badge/Arch%20Linux-1793D1?logo=arch-linux&logoColor=fff&style=for-the-badge)
![Podman](https://img.shields.io/badge/-Podman-892CA0?style=flat-square&logo=podman&logoColor=white)
![Vim](https://img.shields.io/badge/VIM-%2311AB00.svg?style=for-the-badge&logo=vim&logoColor=white)
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
![Forgejo](https://img.shields.io/badge/forgejo-%23FB923C.svg?style=for-the-badge&logo=forgejo&logoColor=white)