diff --git a/README.md b/README.md index 1258921..46e2e97 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,76 @@ -# 4c-manager-public -A public verision of the 4CAMPS Manager repo used only for releases +
+
+
Desktop control client for 4CAMPS computer rooms.
+ + + +--- + +## Overview + +4CAMPS Manager is a **Tauri + React** desktop app used to manage 4CAMPS PCs in real time. +It verifies the local machine through the API, connects to Socket.IO, and reacts to remote actions (block, ping, forms, power actions). + +## Tech Stack + +- **Frontend:** React 19 + TypeScript + Vite +- **Desktop runtime:** Tauri v2 (Rust backend) +- **Realtime:** Socket.IO client +- **Package manager:** Bun + +## Quick Start + +```bash +bun install +``` + +Tauri development mode: + +```bash +bun run tauri dev +``` + +## Scripts + +- `bun run tauri dev` - Run desktop app in dev mode +- `bun run tauri build` - Build production desktop binaries (Won't work for updates) + + +## Project Structure + +- `src/` - React frontend +- `src/routes/` - Route pages +- `src/components/` - Shared UI components +- `src/lib/` - Shared frontend utilities and types +- `src-tauri/src/` - Rust commands and app runtime logic +- `src-tauri/capabilities/` - Tauri capability config + +## Releasing + +1. Stage changes: + ```bash + git add . + ``` +2. Commit: + ```bash + git commit -m "chore: release vX.Y.Z" + ``` +3. Push: + ```bash + git push origin main + ``` +4. Tag: + ```bash + git tag vX.Y.Z + git push origin vX.Y.Z + ``` diff --git a/public/img/dotaznik-icon.svg b/public/img/dotaznik-icon.svg new file mode 100644 index 0000000..3cdc3cd --- /dev/null +++ b/public/img/dotaznik-icon.svg @@ -0,0 +1,17 @@ + diff --git a/public/img/dotaznik-logo.svg b/public/img/dotaznik-logo.svg new file mode 100644 index 0000000..73b58a9 --- /dev/null +++ b/public/img/dotaznik-logo.svg @@ -0,0 +1,18 @@ + diff --git a/public/img/manager-icon.svg b/public/img/manager-icon.svg new file mode 100644 index 0000000..87b9741 --- /dev/null +++ b/public/img/manager-icon.svg @@ -0,0 +1,19 @@ + diff --git a/public/img/manager-logo.svg b/public/img/manager-logo.svg new file mode 100644 index 0000000..c02a462 --- /dev/null +++ b/public/img/manager-logo.svg @@ -0,0 +1,20 @@ +