https://github.com/regisx001/worklog
Worklog is a local-first desktop project manager for small development teams. It is built for fast, keyboard-first planning with a Kanban workflow and zero cloud dependency for core usage.
https://github.com/regisx001/worklog
desktop-application git rust svelte sveltekit tauri typescript
Last synced: about 2 months ago
JSON representation
Worklog is a local-first desktop project manager for small development teams. It is built for fast, keyboard-first planning with a Kanban workflow and zero cloud dependency for core usage.
- Host: GitHub
- URL: https://github.com/regisx001/worklog
- Owner: regisx001
- License: mit
- Created: 2026-03-19T01:31:50.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2026-05-06T14:03:16.000Z (about 2 months ago)
- Last Synced: 2026-05-06T16:10:22.511Z (about 2 months ago)
- Topics: desktop-application, git, rust, svelte, sveltekit, tauri, typescript
- Language: Svelte
- Homepage: https://regisx001.github.io/Worklog/
- Size: 17.1 MB
- Stars: 58
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Worklog : Local-first Desktop Project Manager
***
Worklog is a local-first desktop project manager for small development teams.
It is designed for fast, keyboard-driven planning with a Kanban workflow, transparent local data, and no cloud dependency for core usage.
***
## 🎉 Latest Release — v1.2
> **[Download v1.2.0 for your platform →](https://github.com/regisx001/Worklog/releases/tag/app-v1.2.0)**
v1.2 is a major power-user update that moves Worklog beyond basic task management and into deeper workflow integration. It introduces background Git synchronization, adaptive UI scaling, and direct board management — all without touching the local-first, offline-first foundation.
Kanban Board — full workspace overview
Git Auto-Sync — configure and forget
Global Zoom — 50 % to 200 % with keyboard shortcuts
Board Context Menu — rename and edit without leaving the sidebar
### What shipped in v1.2
**🔄 Git Auto-Sync**
Background scheduler keeps your local workspace in parity with a private GitHub repository. Configure the remote URL, personal access token, branch, and sync interval (1 minute to 6 hours) directly from Settings → Git Sync. Uses a pull-before-push strategy to keep history clean. Toggle auto-sync on or off at any time.
**🔍 Global Application Zoom**
Scale the entire UI from 50 % to 200 % using the Zoom settings tab or live keyboard shortcuts (`Ctrl/Cmd` + `+`, `-`, `0`). The preference is persisted locally and restored on the next launch, so the app always opens at the scale you chose.
**✏️ Edit Board from Sidebar**
Right-click any board in the sidebar to open a context menu with options to open, edit, copy the board ID, or delete. The Edit Board action lets you update the board name and description inline without navigating away from your current view.
**🛠️ Schema Migration Infrastructure**
A professional SQLite migration system (now at schema version 11) ensures that every future feature addition safely migrates existing data with no manual steps and no data loss.
**Full changelog:** https://github.com/regisx001/Worklog/compare/app-v1.1.0...app-v1.2.0
***
## What Worklog Is
Worklog is built around a simple hierarchy:
Workspace -> Board -> Ticket
That structure keeps the app focused on one job: help a small team organize work without turning the product into a heavyweight project suite. The app is meant to feel instant, predictable, and easy to operate from the keyboard.
The concept is intentionally local-first:
- data stays on the machine that owns the workspace
- the app works offline
- the storage model remains transparent and portable
- every meaningful action is explicit
## Product Direction
Worklog is not trying to be a cloud PM platform. The long-term idea is a desktop tool that stays small, fast, and honest about where data lives, while still covering the everyday planning flow a team actually needs.
The product direction centers on:
- board-based planning that stays easy to scan
- quick navigation and command-driven workflows
- lightweight collaboration through transparent local or project data
- Git-friendly, portable project state instead of vendor lock-in
- a clean path from personal planning to small-team coordination
## Current Shape
The app already supports:
- workspace, board, and ticket management
- a Kanban board with Backlog, Todo, In Progress, and Done columns
- ticket details with inline editing and comments
- board and ticket context actions via right-click menus
- command palette and keyboard shortcuts
- workspace persistence with restore on startup
- background Git auto-sync with configurable intervals and pull-before-push strategy
- global application zoom (50 % – 200 %) with keyboard shortcuts and persistence
- Edit Board action from the sidebar context menu
- SQLite schema migration infrastructure for safe, lossless upgrades
## Future Plans
The roadmap is intentionally gradual. The goal is to make Worklog more useful without breaking the core principles above.
Planned areas of growth include:
- stronger board organization tools, such as filters, saved views, and better prioritization
- richer ticket metadata, including more flexible fields for planning and handoff
- better search and navigation across workspaces, boards, and tickets
- more explicit project history and portable workspace snapshots
- improved backup, export, and restore workflows
- deeper Git-native workflows for teams that want work state to stay visible and auditable
- more keyboard shortcuts and faster bulk actions for power users
- continued UI polish, accessibility work, and responsiveness improvements
## How It Works
Worklog uses a layered local architecture:
UI -> hooks -> repository layer -> SQLite
That keeps the app predictable and makes the persistence layer the source of truth for local data. Route and layout boundaries own workspace and board scope, while hooks handle the async work and repository calls.
## Stack
- Desktop shell: Tauri v2
- Frontend: SvelteKit + TypeScript
- Runtime and package manager: Bun
- Persistence: SQLite via the Tauri SQL plugin
- Styling: semantic HTML, app shell styles, and compact desktop-oriented UI patterns
## Project Structure
- [src](src): SvelteKit frontend app
- [src/lib/components/app](src/lib/components/app): App feature components
- [src/lib/hooks](src/lib/hooks): Runes-based state and domain hooks
- [src/lib/db](src/lib/db): Repository and local database layer
- [src-tauri](src-tauri): Rust and Tauri desktop runtime
- [docs](docs): Architecture and dataflow notes
- [.github/workflows](.github/workflows): CI and release pipelines
## Local Data
Worklog stores app data inside the selected workspace path:
- `.worklog/worklog.db`
No cloud backend is required for normal operation.
## Installation
### Debian / Ubuntu
Worklog can be installed through the APT repository using a dedicated keyring file and the `signed-by` option, which is the recommended modern APT setup.[1][2]
```bash
sudo apt update
sudo apt install -y ca-certificates curl gnupg
sudo mkdir -p /usr/share/keyrings
curl -fsSL https://regisx001.github.io/worklog-apt/pubkey.asc \
| sudo gpg --dearmor -o /usr/share/keyrings/worklog-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/worklog-archive-keyring.gpg] https://regisx001.github.io/worklog-apt any main" \
| sudo tee /etc/apt/sources.list.d/worklog.list
sudo apt update
sudo apt install worklog
```
If the repository is already configured, future updates can be installed with the normal system update flow using `sudo apt update && sudo apt upgrade`.[2][3]
### Arch Linux / AUR
Worklog is also available from the Arch User Repository, where AUR packages are typically installed through helpers such as `yay`.[4][5]
```bash
yay -S worklog-bin
```
If `yay` is not installed yet, install it first and then use the command above to install `worklog-bin` from the AUR.[6][5]
## Getting Started
Install dependencies:
```bash
bun install --frozen-lockfile
```
Run the frontend during development:
```bash
bun run dev
```
Run the desktop app during development:
```bash
bun run tauri dev
```
## Development Commands
Type and Svelte checks:
```bash
bun run check
```
Frontend build:
```bash
bun run build
```
Desktop build:
```bash
bun run tauri:build
```
## Keyboard Shortcuts
- `Ctrl/Cmd` + `K`: open command palette
- `Ctrl/Cmd` + `N`: create ticket
- `Ctrl/Cmd` + `B`: open create board dialog
- `Ctrl/Cmd` + `S`: manual sync action
- `Ctrl/Cmd` + `+`: zoom in
- `Ctrl/Cmd` + `-`: zoom out
- `Ctrl/Cmd` + `0`: reset zoom to 100 %
- `M` on a focused ticket: move it to the next status
- `Escape`: close the ticket detail panel
## Prerequisites
- Bun
- Rust stable toolchain
- Tauri system dependencies for your OS
Linux dependencies used in CI:
```bash
sudo apt-get update
sudo apt-get install -y \
build-essential \
pkg-config \
libgtk-3-dev \
libwebkit2gtk-4.1-dev \
libappindicator3-dev \
librsvg2-dev \
patchelf
```
## CI And Releases
The CI workflow lives in [ci.yml](.github/workflows/ci.yml). It runs on pushes and pull requests when core source or build files change.
The publish workflow lives in [release.yml](.github/workflows/release.yml). Releases are tag-driven and trigger when a tag matching `app-v*` is pushed.
### Release Steps
1. Update version in [package.json](package.json), [src-tauri/Cargo.toml](src-tauri/Cargo.toml), and [src-tauri/tauri.conf.json](src-tauri/tauri.conf.json).
2. Commit and push the changes.
3. Create and push a release tag:
```bash
git tag -a app-v0.1.0 -m "Release app-v0.1.0"
git push origin app-v0.1.0
```
4. GitHub Actions builds and uploads artifacts for macOS, Linux, and Windows.
5. The workflow also produces AUR-ready artifacts.
## Recommended IDE Setup
- VS Code
- Svelte extension
- Tauri extension
- rust-analyzer extension
## License
MIT