126 lines
4 KiB
Markdown
126 lines
4 KiB
Markdown
# wutzcalc
|
|
|
|
> ## ⚠️ AI-generated code
|
|
>
|
|
> **Every file in this repository was written by an AI coding assistant.** It
|
|
> has not been independently audited or reviewed line-by-line by a human. Before
|
|
> running this in any setting where correctness matters (real money, real
|
|
> events), read the code yourself, test the edge cases that matter to you, and
|
|
> assume there are bugs. Use at your own risk.
|
|
|
|
Festival drink-sale tracker. See [PLAN.md](PLAN.md) for architecture, [NOTES.md](NOTES.md)
|
|
for the original requirements, and [TODO.md](TODO.md) for deferred work.
|
|
|
|
Source: <https://git.berlin.ccc.de/vinzenz/wutzcalc>
|
|
|
|
## Toolchain setup
|
|
|
|
Requires Node.js 20+ and pnpm 9+. Native SQLite bindings install from prebuilt
|
|
binaries on x86_64 / arm64 — no compiler needed for most setups.
|
|
|
|
### Nix (Linux / macOS)
|
|
|
|
```sh
|
|
nix develop # node 20, pnpm, sqlite, build deps
|
|
```
|
|
|
|
### Debian / Ubuntu
|
|
|
|
```sh
|
|
# Node 20 from NodeSource
|
|
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
|
|
sudo apt install -y nodejs
|
|
sudo corepack enable # provides pnpm
|
|
|
|
# Only needed if a prebuilt better-sqlite3 binary is unavailable for your arch
|
|
sudo apt install -y build-essential python3
|
|
```
|
|
|
|
### Fedora
|
|
|
|
```sh
|
|
# Node 20 + pnpm (corepack ships with the nodejs package)
|
|
sudo dnf install -y nodejs
|
|
sudo corepack enable # provides pnpm
|
|
|
|
# Only needed if a prebuilt better-sqlite3 binary is unavailable for your arch
|
|
sudo dnf install -y gcc-c++ make python3
|
|
```
|
|
|
|
### Windows
|
|
|
|
Install Node.js 20 LTS via the official MSI from <https://nodejs.org> (this
|
|
also installs the optional "Tools for Native Modules"). Then in PowerShell:
|
|
|
|
```powershell
|
|
corepack enable # provides pnpm
|
|
```
|
|
|
|
Use PowerShell to set env vars on the same line, e.g.
|
|
`$env:ADMIN_PASSWORD="changeme"; pnpm dev:server`.
|
|
|
|
## Dev
|
|
|
|
```sh
|
|
pnpm install
|
|
ADMIN_PASSWORD=changeme pnpm dev:server # http://localhost:3000
|
|
pnpm dev:client # http://localhost:5173 (proxies /api, /admin)
|
|
```
|
|
|
|
Open `http://localhost:5173/` for the tablet UI and
|
|
`http://localhost:5173/admin.html` for the backoffice.
|
|
|
|
## Production build
|
|
|
|
```sh
|
|
pnpm install
|
|
pnpm build
|
|
ADMIN_PASSWORD=... DB_PATH=/var/lib/wutzcalc/wutz.db node server/dist/index.js
|
|
```
|
|
|
|
Single Node process serves the API, both client entries (`/` tablet,
|
|
`/admin` backoffice), and writes to one SQLite file.
|
|
|
|
## Run as a systemd service
|
|
|
|
Template files live in [`deploy/`](deploy/): a unit ([`wutzcalc.service`](deploy/wutzcalc.service))
|
|
and an environment file ([`wutzcalc.env.example`](deploy/wutzcalc.env.example)).
|
|
They assume the built app lives in `/opt/wutzcalc` and the database in
|
|
`/var/lib/wutzcalc` — adjust paths in the unit if yours differ.
|
|
|
|
```sh
|
|
# 1. Dedicated system user (no login, no home)
|
|
sudo useradd --system --no-create-home --shell /usr/sbin/nologin wutzcalc
|
|
|
|
# 2. Install the built app (run `pnpm install && pnpm build` first)
|
|
sudo mkdir -p /opt/wutzcalc
|
|
sudo cp -a . /opt/wutzcalc # or rsync/checkout into place
|
|
sudo chown -R root:root /opt/wutzcalc # app dir stays read-only to the service
|
|
|
|
# 3. Config + secrets (chmod 600 — holds ADMIN_PASSWORD)
|
|
sudo mkdir -p /etc/wutzcalc
|
|
sudo install -m 600 deploy/wutzcalc.env.example /etc/wutzcalc/wutzcalc.env
|
|
sudoedit /etc/wutzcalc/wutzcalc.env # set ADMIN_PASSWORD
|
|
|
|
# 4. Install and start the unit
|
|
sudo cp deploy/wutzcalc.service /etc/systemd/system/
|
|
sudo systemctl daemon-reload
|
|
sudo systemctl enable --now wutzcalc
|
|
|
|
# Logs / status
|
|
systemctl status wutzcalc
|
|
journalctl -u wutzcalc -f
|
|
```
|
|
|
|
Confirm `ExecStart` matches your Node path (`command -v node`) — it defaults to
|
|
`/usr/bin/node`. The unit creates `/var/lib/wutzcalc` via `StateDirectory`, so
|
|
the service user owns the database directory automatically.
|
|
|
|
## Env vars
|
|
|
|
- `PORT` (default `3000`)
|
|
- `HOST` (default `0.0.0.0`)
|
|
- `DB_PATH` (default `./wutz.db`)
|
|
- `ADMIN_PASSWORD` (**required** for backoffice login)
|
|
- `WUTZ_TZ` (default `Europe/Berlin`) — timezone for stats display and grouping
|
|
- `WUTZ_DAY_CUTOFF_HOUR` (default `5`) — sales before this local hour count toward the previous business day
|