Development Guide

Welcome to the Worklog contributor community! This guide will help you set up your local environment and build the application from source.

Prerequisites

Before you begin, ensure you have the following tools installed on your machine:

Bun: The primary runtime and package manager. Install Bun
Rust: The stable toolchain is required for the Tauri backend. Install Rust
System Dependencies: Linux users will need several GTK and WebKit libraries.

Linux Dependencies (Ubuntu/Debian)

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

Environment Setup

1. Clone the repository

Pull the latest source code to your machine.

git clone https://github.com/regisx001/Worklog.git
cd Worklog

2. Install dependencies

Use Bun to install all frontend and backend requirements.

bun install --frozen-lockfile

Development Commands

Worklog provides several commands to help you develop and test the application:

Command	Description
`bun run dev`	Run the frontend (SvelteKit) with hot-reloading in the browser.
`bun run tauri dev`	Run the full desktop application in development mode.
`bun run check`	Run TypeScript and Svelte diagnostics.
`bun run tauri:build`	Generate production binaries for your current platform.

Project Structure

/src

SvelteKit frontend application

/src-tauri

Rust backend & Tauri config

Contributing

We welcome contributions of all kinds! Whether it’s fixing a bug, suggesting a feature, or improving documentation.

Fork the repository.
Create a new branch for your feature or fix.
Submit a Pull Request with a clear description of your changes.
Ensure all checks (bun run check) pass before submission.

Next: Privacy →