Project Name

Description: Empty Rust project template for a Design-First workflow. Includes a clean directory structure (docs/src/tests), a local Obsidian workspace for project management (Kanban), and a pre-configured CI pipeline.

---

🗺️ Vision & Goals

A 2-3 sentence summary of the "Why" behind this project and the exact problem it solves.

• Main Goal:
• Target Audience / Use Case:

---

🧠 Design-First (Obsidian Workspace)

All design, task tracking, and documentation are located in the docs/ folder. To manage this project, open the root of this repository as a vault in Obsidian.

• 📋 Project Board: [[docs/Kanban]] (or the path to your Kanban file)
• 👤 Specifications / User Stories: [[docs/user-stories/]]

---

🛠️ Technical Stack

• Language: Rust (stable)
• Testing: Built-in cargo test (unit tests in src/, integration tests in tests/)
• CI/CD: GitHub Actions / Forgejo Actions (.github/workflows/build.yml)

---

🚀 Quick Start

Prerequisites

• Rust toolchain (via rustup)
• IDE (RustRover / VS Code with rust-analyzer)
• Obsidian (for project management)

Useful Commands

# Build the project
cargo build

# Run the project
cargo run

# Run tests
cargo test

# Format & lint
cargo fmt
cargo clippy

---

🛠️ Project Management & Obsidian Setup

To keep this repository completely clean, we do not version third-party code. Therefore, the entire .obsidian/plugins/ folder is excluded from Git. Only your local markdown files, templates, and core configuration files are tracked.

When cloning this project for the first time, you will need to manually download the 3 required plugins to restore the workspace.

📥 Required Plugins

Open Obsidian, go to Settings (⚙️) -> Community plugins -> Browse, and install:

1. Kanban (by mgmeyers) — For visual sprint boards and tasks management.
2. Excalidraw (by Zsolt Viczian) — For technical sketches and architecture diagrams.
3. Tasks (by Clare Macrae, Ilyas Landikov, and Martin Schenck) — For tracking and filtering checklist items.

🚀 First-Time Activation Steps

1. Open Obsidian and click "Open folder as vault" on the repository's root.
2. Turn on Community Plugins in the settings.
3. Download, install, and turn ON the 3 plugins listed above.
4. In Settings -> Files and links, make sure Default location for new notes is set to In the folder specified below with the path docs/items.

Once done, your Kanban boards and settings will automatically synchronize with the plugins.