subbers 0.1.0

Manage your sports game subs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# subbers

Manage subs for your sports game.

Only HTTP Basic Authentication is supported so consider running an
authentication proxy in front or access the app via VPN or similar.

## Getting Started

#### Start app

```
cargo run
```

- [View app](http://localhost:8080/)
- [View metrics](http://localhost:8081/metrics)

Alternatively:

```
$ cargo run -- --help
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.08s
     Running `target/debug/subbers --help`
Manage your sports game subs

Usage: subbers [OPTIONS]

Options:
  -s, --sqlite-filepath <SQLITE_FILEPATH>
          SQLite file path [default: subbers.sql]
  -l, --listen-addr <LISTEN_ADDR>
          Listen Address for HTTP server [default: 0.0.0.0:8080]
  -m, --metrics-listen-addr <METRICS_LISTEN_ADDR>
          Listen Address for Prometheus Metrics HTTP server [default: 0.0.0.0:8081]
  -b, --basic-auth <BASIC_AUTH>
          Basic Auth 'user:pass' for HTTP server
  -h, --help
          Print help
  -V, --version
          Print version
```

#### Create Players

All created players are available to sub in games.

Edit a player to change their name and number. Past games are not updated to the new name/number.

#### Create Game

In the games table click `new` then click on the game number to manage it.

#### Game Actions

| Table  | Column  | Action | Outcome                                                                                                    |
| ------ | ------- | ------ | ---------------------------------------------------------------------------------------------------------- |
| Game   | Started | Play   | begin the game timer and the first period. Page refreshes every 5 seconds.                                 |
| Game   | Ended   | Stop   | stop the game timer and sub off all players. Players game statistics are added to their global statistics. |
| Game   | Period  | Play   | start the period, enable players to sub on.                                                                |
| Game   | Period  | Stop   | stop the period and sub all players off. Page stops refreshing.                                            |
| Game   | MVP     | Select | upsert MVP.                                                                                                |
| Player | Sub     | Play   | sub player on, increasing play count and starting duration timer.                                          |
| Player | Sub     | Pause  | sub player off.                                                                                            |

#### Deleting Players and Games

TODO.

Use [DB Browser for SQLite](https://sqlitebrowser.org/) or similar to edit the SQL file directly.

## Cross compiling

If you have [nix](https://github.com/NixOS/nix) installed, you can cross
compile via:

```sh
nix build .#subbers-x86_64-linux

nix build .#subbers-aarch64-linux
```

## Contributing

This project was built to manage my son's basketball games and to experiment
with different software libraries and code patterns.

Whilst the project is feature complete for my use case there are many
directions it could take. Please feel free to fork or create an issue to
discuss.

## Thanks

Creators of the following:

- [Beer CSS](https://github.com/beercss/beercss)
- [Maud](https://github.com/lambda-fairy/maud)
- [axum](https://github.com/tokio-rs/axum)
- [htmx](https://htmx.org/)
- [Rust](https://www.rust-lang.org/)