- manifest.webmanifest: standalone display mode, theme #2563eb, start_url=/app.html (so users who install land in the app shell, not the marketing page), scope=/. Three icons: 192px any-purpose, 512px any-purpose, 512px maskable for adaptive icons on Android. - icons/: PNGs generated from favicon.svg. - sw.js: cache-first for the precached app shell, network-first for /api/* and /auth/* (we never serve stale auth or notes). Versioned cache name (librenotes-shell-v1) so a SW update evicts old assets. skipWaiting + clients.claim so a new SW takes over without a manual reload. - pwa.js: registers the SW on every page and handles beforeinstallprompt by showing #install-btn. Hides the button again on appinstalled. Defer loaded so it never blocks render. - All HTML pages link the manifest, set the theme-color meta, and load pwa.js. Landing page exposes the install button next to the existing CTAs. Closes #19. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
librenotes
Cloud-native, multi-tenant notes application. A fork of Notesium extended with authentication, per-user data isolation, sync, and PWA support so it can run as a hosted service at librenot.es.
Features
- Markdown notes with bi-directional links (Zettelkasten / evergreen notes)
- Embedded web app — no Electron, no Node runtime, single static binary
- Multi-tenant backend with magic-link authentication (in development)
- Offline-capable PWA with background sync (planned, Phase 4)
Build
Requires Go 1.20 or later.
go build ./cmd/librenotes
This produces a librenotes binary in the current directory. The web
frontend and shell completion are embedded into the binary at compile
time, so no extra files are needed at runtime.
A Makefile with build, test, run, and clean targets is provided
for convenience:
make build
make test
Run
./librenotes web --notes-dir ~/notes
See ./librenotes help for the full command list.
Development setup
A Nix flake provides a reproducible development environment with Go,
build tools, and the project CLIs. Use the plain dev shell for a
non-sandboxed Go toolchain:
nix develop .#dev
Alternatively, build a Docker-based dev environment:
docker build -f Dockerfile.dev -t librenotes-dev .
docker run --rm -it -v "$PWD:/workspace" librenotes-dev
The repository layout follows the standard Go project structure:
cmd/librenotes/ Binary entry point
internal/notesium/ Core notes package (forked from Notesium)
internal/notesium/web/ Embedded frontend assets
The Go module path is git.librete.ch/public/librenotes.
Fork attribution
librenotes is a fork of Notesium by Alon Swartz, used and redistributed under the MIT License. See NOTICE for the upstream commit hash at fork time and instructions for tracking upstream changes.
License
MIT — see LICENSE. Copyright is shared between the original Notesium author and the librenotes contributors.