Files
mflow/README.md
Malte Schröder d6b31101c4 new Readme
2025-12-23 16:09:13 +01:00

2.1 KiB

mflow

mflow ist eine leichte, in Rust geschriebene Anwendung zur Verwaltung von Projekten und Notizen. Sie basiert auf dem Dioxus-Framework und unterstützt sowohl Desktop- als auch Web-Umgebungen.

🚀 Funktionen

  • Projektverwaltung: Erstelle, bearbeite und lösche Projekte einfach über die Seitenleiste.
  • Live-Editor: Bearbeite Projekttitel und Inhalte in Echtzeit.
  • Automatische Speicherung:
    • Desktop: Speichert Daten automatisch in einer projects.json Datei im Arbeitsverzeichnis.
    • Web: Nutzt den LocalStorage des Browsers, damit deine Daten erhalten bleiben.
  • Sicherheitsabfrage: Bestätigungsdialog beim Löschen von Projekten, um Datenverlust zu vermeiden.
  • Cross-Platform: Läuft nativ auf dem Desktop und im Browser (WASM).

🛠️ Technologien

  • Sprache: Rust (Edition 2021)
  • UI Framework: Dioxus (v0.7.1)
  • Daten-Serialisierung: serde & serde_json
  • Storage (Web): gloo-storage

📦 Installation & Nutzung

Stelle sicher, dass du Rust und die Dioxus CLI installiert hast.

# Dioxus CLI installieren (falls noch nicht vorhanden)
cargo install dioxus-cli

Projekt klonen

git clone https://github.com/dein-username/mflow.git
cd mflow

🖥️ Desktop starten

Um die Anwendung als native Desktop-App zu starten:

# Mit Dioxus CLI (empfohlen, unterstützt Hot-Reloading)
dx serve --platform desktop

# Oder klassisch mit Cargo
cargo run --features desktop

🌐 Web-Version starten

Um die Anwendung im Browser zu starten:

dx serve --platform web

Die Anwendung ist dann unter http://localhost:8080 erreichbar.

📂 Projektstruktur

  • src/main.rs: Einstiegspunkt der Anwendung.
  • src/ui.rs: Enthält die Hauptlogik und UI-Komponenten (Hero Component).
  • assets/: Statische Dateien wie CSS und Icons.
  • Dioxus.toml: Konfiguration für das Dioxus-Tooling.

📝 Lizenz

Dieses Projekt wurde erstellt von [malxte].