Skip to content
/ uml Public

A modern, intuitive desktop application for creating and editing UML diagrams with real-time rendering. Built using Tauri and React TypeScript

License

Notifications You must be signed in to change notification settings

hudy9x/uml

Repository files navigation

UML Desktop Editor

Uml editor

GitHub stars GitHub commits GitHub release License

A modern, intuitive desktop application for creating and editing UML diagrams with real-time rendering. Built using Tauri and React TypeScript, it combines native performance with a beautiful, modern UI powered by shadcn/ui components.

✨ Features

  • 🚀 Real-time UML diagram rendering and preview
  • 💻 Desktop-native performance with Tauri
  • 🎨 Modern UI with shadcn/ui components
  • 🌐 Cross-platform support (macOS, Windows, Linux)
  • 📝 Code-based UML editing with syntax highlighting
  • 🔄 Live preview updates
  • 💾 Local project management and storage
  • 🎯 Zoom and pan controls for diagram viewing
  • 🌙 Light/Dark theme support

🚀 Prerequisites

Before you begin, ensure you have the following installed:

🛠️ Development Setup

  1. Clone the repository:
git clone https://github.com/hudy9x/uml.git
cd uml
  1. Install dependencies:
pnpm install
  1. Start development server:
pnpm tauri:dev

📜 Available Scripts

  • pnpm dev - Start Vite development server
  • pnpm build - Build the application (TypeScript compilation + Vite build)
  • pnpm preview - Preview the built application
  • pnpm tauri - Run Tauri commands
  • pnpm tauri:dev - Start Tauri development environment

🏗️ Building for Production

To create a production build:

pnpm build

This will generate platform-specific binaries in the src-tauri/target/release directory.

🔧 Tech Stack

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • PlantUML - UML diagram generation
  • Tauri - For making desktop development with web technologies amazing
  • All our contributors and users who make this project better every day

About

A modern, intuitive desktop application for creating and editing UML diagrams with real-time rendering. Built using Tauri and React TypeScript

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published