How lolzboring/dnote works
Project type and purpose
• This is a full-stack, multi-client personal knowledge-base application (Dnote).
• It comprises:
• A server (Go) exposing a REST/JSON API, backed by SQLite/PostgreSQL migrations.
• Multiple clients:
– CLI (Go) with local storage and sync.
– Browser extension (TypeScript/React).
– Web application (TypeScript/React).
– Shared JS library (jslib) providing common helpers and service layers.
• Purpose: capture, store, sync, and review notes across devices with spaced repetition.
File structure
• Top-level directories:
• pkg/cli: Go CLI with local DB, commands (add, edit, sync, login, etc.).
• pkg/server: Go API server, database layer, background jobs, mailer.
• browser: Chrome/Firefox extension, UI in React/TS, uses jslib.
• web: Web client in React/TS, webpack builds.
• jslib: Shared JS/TS helpers, operations, services.
• Key config/build files:
• Makefile, Travis CI, Gopkg.{toml,lock} for Go dependencies.
• browser/package.json & webpack.config.js.
• web/webpack and package.json.
• pkg/server/.env.*, database/sql-migrate.yml.
• Architectural patterns:
• REST API layer in server/api/handlers → operations → presenters.
• CLI and clients use service modules to call HTTP endpoints.
• Shared state management per client via Redux-style stores.
README for additional insights
• Confirms multi-client support, local storage (SQLite), sync to server, email jobs, spaced repetition.
• Mentions self-hosting instructions (SELF_HOSTING.md).