56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
# Scrum Solitare
|
|
|
|
Win98-themed Scrum Poker web app scaffold using Go + Gin.
|
|
|
|
## Features
|
|
|
|
- Gin server with default port `8002`
|
|
- Gzip compression enabled
|
|
- Cache headers for static `css`, `js`, and image assets
|
|
- Template rendering from `src/templates`
|
|
- Static file hosting from `static/`
|
|
- `/` currently serves a room configuration page (UI only)
|
|
|
|
## Project Layout
|
|
|
|
- `src/main.go`: Application bootstrap
|
|
- `src/config/`: Environment and runtime configuration
|
|
- `src/server/`: Gin engine construction and middleware wiring
|
|
- `src/routes/`: Route registration
|
|
- `src/controllers/`: HTTP handlers/controllers
|
|
- `src/middleware/`: Custom Gin middleware
|
|
- `src/models/`: Page/view data models
|
|
- `src/templates/`: HTML templates (`header`, `body`, `footer`, and `index` composition)
|
|
- `static/css/`: Stylesheets
|
|
- `static/js/`: Frontend scripts
|
|
- `static/img/`: Image assets
|
|
|
|
## Run Locally
|
|
|
|
```bash
|
|
go mod tidy
|
|
go run ./src
|
|
```
|
|
|
|
Open `http://localhost:8002`.
|
|
|
|
## Environment Variables
|
|
|
|
- `PORT`: Optional server port override (default is `8002`)
|
|
|
|
## Docker
|
|
|
|
Build image:
|
|
|
|
```bash
|
|
docker build -t scrum-solitare .
|
|
```
|
|
|
|
Run container:
|
|
|
|
```bash
|
|
docker run --rm -p 8002:8002 scrum-solitare
|
|
```
|
|
|
|
Then open `http://localhost:8002`.
|