1
0
Fork 0
mirror of https://git.anardil.net/austin/board.git synced 2026-11-21 11:00:03 +00:00
Custom web UI for Vikunja
  • JavaScript 57%
  • Haskell 39.9%
  • CSS 2.5%
  • Makefile 0.4%
  • HTML 0.2%
Find a file
Gandalf- 674fd2095c board: a tile shows its scope under its title
The title line drops its "scope: " prefix; the line under it reads #N,
the scope in its tile's hue (grey when done), then due, comments and the
rest. The card page and every write keep the full title. A list row
leaves that line off when it would hold only the number, so a grocery
row stays one line. J4 types a weekday three days on, not "fri", which
on a Thursday is the 1-day chip.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-19 09:44:03 -08:00
dev board: remove legacy labels 2026-11-18 16:47:05 -08:00
server board: remove legacy labels 2026-11-18 16:47:05 -08:00
test board: a tile shows its scope under its title 2026-11-19 09:44:03 -08:00
www board: a tile shows its scope under its title 2026-11-19 09:44:03 -08:00
.gitignore board: the fixture is made by board-server's admin commands and API, so Vikunja leaves the repo 2026-11-15 18:33:57 -08:00
CLAUDE.md board: make install puts board-cli where vikunja.sh runs it; the CLI test runs board-cli alone 2026-11-18 08:03:58 -08:00
LICENSE board: a README and MIT license, and no private hosts or paths, for the public mirror 2026-11-11 12:47:19 -08:00
Makefile board: make install puts board-cli where vikunja.sh runs it; the CLI test runs board-cli alone 2026-11-18 08:03:58 -08:00
README.md board: remove legacy labels 2026-11-18 16:47:05 -08:00

board

A small, fast task board: a kanban board of specs on a laptop, and to-dos ticked off on a phone. It began as a front end for Vikunja and still speaks the part of Vikunja's API its clients use: the app, and board-cli, the command line.

Plain HTML, CSS and vanilla ES modules: no framework, no build step, no npm.

server/ is the backend, board-server, in Haskell: it answers the part of Vikunja's API the app and board-cli use, over its own SQLite database. Its admin commands make what neither client can (users, projects and their views, buckets, tokens), and it can import a Vikunja database. The tests run the app against it, over sample data those commands and the API make.

What it does

  • Kanban boards. Columns on a laptop, one bucket at a time on a phone with a tab strip to switch. Swipe a tile to the next or previous column; collapse the columns you don't need.
  • Lists for to-dos. Soonest due first. Swipe to close or postpone, with undo, and anything closed by mistake can be found again under Recently done.
  • Triage without opening a card. Bucket, priority and done from a tile's menu, or with the keyboard on an open card (0–5 priority, m move, d done, e edit, c comment).
  • Cards in full. Description and comments, shown over the board so closing the card leaves the board as it was. Stored HTML is sanitised against an allowlist before it reaches the page.
  • Filter by scope and words. Titles that lead with a scope (torrent: …) get a colour and a chip; torrent: season shows that scope's cards that mention a season. The filter is in the address, so reload and back keep it.
  • Writes show at once. Every change is drawn immediately, sent to the API after, and put back if it fails. A write that gets no answer is checked rather than assumed. What's on screen is read again when the page comes back into view, so changes made elsewhere show up.
  • Installable. It has a web app manifest and a service worker, so Chrome can install it on a phone or desktop.

Running it locally

Development needs Node 24, Stack for server/, and Google Chrome for the acceptance tests.

make server       # build board-server into vendor/
make fixture      # a fresh local database: sample projects by the admin commands and the API
make serve        # the app at http://127.0.0.1:8493/app/ on board-server

make serve prints the sample users and password. Everything runs on 127.0.0.1 against a database under run/; nothing here can reach the real board.

Tests

make lint         # every module parses as an ES module
make test         # unit tests (node --test)
make check        # after an edit: changed modules parse, and the unit tests
make journey F=board T='J1 board'   # one file, or the journeys matching a name
make acceptance   # journeys in headless Chrome at 1280px and 390px, then timings
make timings      # the timings alone
make ready        # lint, test and what the change needs: run before every commit
make server-ready # server/'s own: format, hlint, its hspec suite

make ready runs the journeys unless only *.md files changed, the timings only when www/ or what they measure through changed, and server-ready when server/ changed; a clean tree runs everything.

Each acceptance journey gets its own copy of the fixture database, its own board-server and its own Chrome, under the same Content Security Policy production sends.

Deploying

The app and the server deploy separately.

The app. Copy www/ to a directory your web server serves at /app/ on the same origin as board-server (the app calls /api/v1/ relative to its own host). Send the policy in dev/proxy.mjs (CSP) as its Content-Security-Policy, and Cache-Control: no-cache so every load picks up a new version. Nothing needs to restart.

make sync does that copy with rsync, once SYNC_DEST is set, for example in an untracked local.mk:

SYNC_DEST = host:/path/to/board/

It ships only committed files, and refuses while www/ has uncommitted changes.

The server. gmake deploy, run on the builder (aspen), builds a release board-server from a committed server/ and installs it where the jail running it reads its binary; the running server keeps the old one until it is restarted. Only board-server serve migrates its database, so the restart is when a new schema takes effect. The production setup (the jail, nginx in front of it, the service, backups, and rolling back) is in infrastructure/todo.

board-server replaced Vikunja in production on 2026-11-15. Vikunja's database and binary stay on the host, untouched, for a rollback until they are deleted, and board-server import is kept until then.

Layout

www/            the app: index.html, one module per feature in js/, its styles in css/
server/         board-server, the Haskell backend (its own Makefile and specs)
dev/            local board-server, fixture, proxy and helpers (node, no dependencies)
test/           unit tests; test/acceptance/ drives Chrome over CDP

CLAUDE.md holds the design rules the code is held to.

License

MIT; see LICENSE.