Skip to content

Getting Started

marcushbsh23 edited this page Aug 24, 2026 · 2 revisions

Getting Started

Requirements

Clone and run in dev mode

git clone https://github.com/Behnooddev/Web-VoidGuard.git
cd voidguard
npm install
npm run tauri dev

This opens the app window with hot-reloading on the frontend and auto-rebuild on the Rust backend.

Build a release installer

npm run tauri build

Produces an MSI and NSIS installer under src-tauri/target/release/bundle/.

First run

  • The dashboard should immediately show live CPU/RAM/disk/process numbers, updating every couple of seconds.
  • Processes, Network (Adapters + Open Ports tabs), Services, Files, Startup, and Events are fully functional. Everything else in the sidebar may show a "not implemented yet" card — see the Roadmap for what's built and what isn't yet.
  • The database is created at %APPDATA%/VoidGuard/voidguard.db.

Where things live

What Where
Frontend src/
Rust backend src-tauri/src/
Per-subsystem commands src-tauri/src/commands/*.rs
Database schema src-tauri/src/db/mod.rs
Docs ARCHITECTURE.md, SECURITY.md, DEVELOPMENT.md
Phase handoffs handoffs/

See Architecture for the full module map and CONTRIBUTING.md in the repo root before sending a PR.

Clone this wiki locally