libretechandClaude Opus 4.7 c92d4bf953 Add first-run onboarding flow
cmd/librenotes/web/public/onboarding.js triggers after a session
is verified and runs only when the tenant-scoped key
"onboarded" is unset.

Behaviour:
- Reads the dismissal flag from authClient.tenantStore() so each
  tenant's state is isolated and survives logout-then-login on
  the same device only if they're the same user.
- Lists /api/notes; if the notebook is empty, PUTs a sample
  "welcome" note so a brand-new user has somewhere to land. We
  don't seed when notes already exist (covers signing in on a
  second device for the first time).
- Opens app.html's <dialog id="onboarding-dialog"> with showModal
  and persists "onboarded": true on submit so returning users
  never see it again.
- Seed failures are logged but do not block the dialog —
  onboarding shouldn't depend on a successful network round
  trip. The dialog just won't have a sample note to point at.

Dialog content covers the four user-guide concepts: notes-as-
markdown, [[wikilinks]], offline-first sync, tenant isolation.

Service worker precaches onboarding.js so the dialog is also
available to offline-first returning visitors.

Closes #32.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-28 23:19:13 +02:00
2026-04-28 21:58:59 +02:00
2026-04-28 21:58:59 +02:00

librenotes

CI

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.

Documentation

Contributing

See CONTRIBUTING.md for setup, conventions, and the PR process. By participating you agree to the Code of Conduct.

License

MIT — see LICENSE. Copyright is shared between the original Notesium author and the librenotes contributors.

S
Description
No description provided
Readme MIT
987 KiB
2026-04-29 01:30:06 +02:00
Languages
JavaScript 51.3%
Go 33.8%
HTML 8%
Shell 2.9%
CSS 2.4%
Other 1.6%