Developer Setup

Developer Setup

This guide explains how to build and run Konserve from source, intended for developers and contributors.

---

Requirements

To build Konserve, you'll need:

• Rust (latest stable)
• Cargo (comes with Rust)
• Git
• A Windows system (recommended for GUI testing)
• Optional: VS Code or any Rust-compatible IDE

---

Clone the Repository

git clone https://github.com/YOUR_USERNAME/konserve.git
cd konserve

---

Install Rust (if needed)

If you don't have Rust installed:

curl https://sh.rustup.rs -sSf | sh

Or use the official installer from https://rust-lang.org

---

Build the Project

Build in release mode:

cargo build --release

The output binary will be in:

target/release/konserve.exe

---

Running Konserve

You can run the app using:

cargo run --release

---

Directory Structure

• src/ – main GUI logic, backup and restore handlers
• assets/ – contains icon.png
• backup/, restore/, helpers/ – modular functionality
• templates/ – user-defined templates (optional)
• Cargo.toml – dependencies and metadata

---

GUI Framework

Konserve uses:

• eframe
• egui for drawing the interface
• rfd for native file/folder pickers

All dependencies are defined in Cargo.toml.

---

Debugging

Konserve uses println!() statements for step-by-step debugging. Run in a terminal to view output.

---

Optional: Native Icon

To include the custom icon:

• Ensure assets/icon.png exists
• It is embedded via include_bytes!

---

Contributing

Feel free to open issues or pull requests. Keep code clean and consistent. Follow idiomatic Rust practices.

---

Next: Troubleshooting