diff --git a/README.md b/README.md index f8132e6..8a73b73 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,40 @@ -# Tauri + Dioxus +# Sandcrate -This template should help get you started developing with Tauri and Dioxus. +A plugin management system with a Rust backend and React frontend. -## Recommended IDE Setup +## Components -[VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) + [Dioxus](https://marketplace.visualstudio.com/items?itemName=DioxusLabs.dioxus). +- **Backend** (`sandcrate-backend/`): Rust API server with plugin execution capabilities +- **Frontend** (`sandcrate-react/`): React web application with authentication and plugin management +- **CLI** (`sandcrate-cli/`): Command-line interface +- **Plugin SDK** (`sandcrate-plugin/`): Plugin development kit + +## Quick Start + +### Backend +```bash +cd sandcrate-backend +cargo run +``` +Server runs on `http://localhost:3000` + +### Frontend +```bash +cd sandcrate-react +npm install +npm run dev +``` +App runs on `http://localhost:5173` + +## Features + +- Plugin execution with WASM support +- User authentication +- Web-based plugin management interface +- RESTful API + +## Tech Stack + +- **Backend**: Rust, Axum, Tokio, Wasmtime +- **Frontend**: React, TypeScript, Tailwind CSS, Vite +- **Authentication**: JWT, PAM