Skip to content
Rick8509Public

About

TuxNotes - open notes for Linux. A lightweight, local-first notes app with an Apple Notes-style design and Google Drive backup.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

TuxNotes

Open notes for Linux. A lightweight, local-first notes app with a clean three-pane design inspired by Apple Notes.

Status: early development (v0.1). Google Drive backup is planned for v0.2.

Features

  • Three panes: folders, note list and editor
  • Rich text: title, heading and subheading styles, bold, italic, underline, strikethrough, monospaced blocks, quotes
  • Checklists with round checkboxes, plus bulleted and numbered lists
  • Pinned notes, folders, and Recently Deleted (notes are removed permanently after 30 days)
  • Fast full-text search that ignores accents ("cafe" finds "café")
  • Autosave, light and dark themes that follow your system, keyboard-first workflow
  • Small and fast: built with Tauri and stored in a single SQLite file

Keyboard shortcuts

Action Shortcut
New note Ctrl+N
New folder Ctrl+Shift+N
Search Ctrl+F
Delete note Ctrl+Delete
Checklist Ctrl+Shift+L
Title / Heading / Subheading / Body Ctrl+Shift+T / H / J / B
Bold / Italic / Underline / Strikethrough Ctrl+B / I / U / Ctrl+Shift+S

Where are my notes?

Everything is stored locally in ~/.local/share/io.github.tuxnotes.TuxNotes/notes.db (SQLite).

Building from source

1. Install the requirements (Debian/Ubuntu)

sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev \
  librsvg2-dev libssl-dev libxdo-dev build-essential curl wget file
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh   # Rust 1.90 or newer
# Node.js 20+ is also required

For Fedora, Arch and other distributions, see the Tauri prerequisites.

2. Run it in development mode

npm install            # first time only, and after dependencies change
npm run tauri dev

Leave it running while you work:

  • Changes in src/ (the interface) appear in the window almost instantly, with no restart.
  • Changes in src-tauri/ or crates/ (Rust) make it recompile and restart the app automatically (usually 5–20 s).

The first build takes a few minutes; later builds are incremental.

3. Build installable packages

npx tauri build --bundles deb    # only the .deb (fastest)
npx tauri build                  # .deb, .rpm and AppImage

Packages are written to target/release/bundle/<format>/. To install or update your local copy:

sudo apt install ./target/release/bundle/deb/TuxNotes_*_amd64.deb

Rebuilding or reinstalling never touches your notes, which live in ~/.local/share/io.github.tuxnotes.TuxNotes/.

Working on the UI without Rust

npm run dev serves the interface at http://localhost:1420 in a normal browser. A built-in mock backend stores data in localStorage, so no Rust toolchain is needed.

Project layout

crates/tuxnotes-core/   Storage engine: SQLite, migrations, search, trash, snapshots (no GUI deps)
src-tauri/              Desktop shell: window and IPC commands that call tuxnotes-core
src/                    Svelte 5 + TipTap user interface

Development checks

Run these before committing. CI runs the same checks on every pull request.

cargo fmt --all                   # format Rust code
cargo test -p tuxnotes-core       # storage engine tests
cargo clippy --workspace --all-targets -- -D warnings
npm run check && npm test         # typecheck + frontend unit tests

Releasing

Push a version tag; GitHub Actions builds the Linux packages and creates a draft release:

git tag v0.1.0 && git push origin v0.1.0

Bump the version first in package.json, Cargo.toml (workspace) and src-tauri/tauri.conf.json.

Roadmap

  • v0.1: folders, notes, rich text, checklists, search, pinning, Recently Deleted
  • v0.2: backup to and restore from Google Drive, with automatic scheduled backups
  • v0.3: images and attachments, tables, Markdown and PDF export, encrypted backups
  • Flathub release

License

MIT

About

TuxNotes - open notes for Linux. A lightweight, local-first notes app with an Apple Notes-style design and Google Drive backup.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages