Modern Desktop Application Development Platform
Build powerful cross-platform desktop applications with cutting-edge technologies
Voltz is a sophisticated development platform that empowers developers to create high-performance desktop applications using modern web technologies. Built on a foundation of TypeScript, React, and Electron, Voltz provides an enterprise-grade architecture with service-oriented design patterns, dependency injection, and comprehensive tooling for professional desktop application development.
Note: Voltz is currently in early development. You may encounter bugs or unexpected behavior. While the core functionality works, features and APIs may change as the project evolves.
Voltz is built on top of electron-vite, a next-generation build tool that significantly enhances the Electron development experience:
- Lightning-fast HMR: Utilizes Vite's near-instantaneous hot module replacement
- Optimized Build Process: Streamlined bundling for both main and renderer processes
- Simplified Configuration: Pre-configured development environment with sensible defaults
- TypeScript Integration: First-class TypeScript support across all processes
- Efficient Asset Handling: Optimized static asset management and importing
By leveraging electron-vite, Voltz delivers a seamless development workflow with instant feedback loops, intelligent process management, and optimized production builds - all while maintaining a clean separation between main and renderer processes.
- Service-Oriented Architecture: Modular design with clear separation of concerns
- Type Safety: Full TypeScript integration across all layers
- Developer Experience: Hot reload, comprehensive tooling, and intuitive APIs
- Pre-Made with Custom Title Bar: Native-feeling title bar with integrated window controls, menu system, and application branding for a polished, professional appearance
Unlike standard Electron boilerplates, Voltz goes beyond the basics to deliver a complete development ecosystem:
- Ready-to-Use UI Components: Pre-configured shadcn/ui components with TailwindCSS 4, saving weeks of UI setup and styling
- Complete DI System: Fependency injection system for services and controllers
- TypeScript Decorators: Advanced decorator system for IPC communication and service lifecycle management
- Intelligent Process Bridge: Type-safe bridge between main and renderer processes that eliminates common IPC headaches
- Optimized Build Pipeline: Production-ready build system with automatic platform-specific optimizations
- Built-in Persistent Store: Type-safe data persistence system for application settings and data storage, eliminating the need for external libraries
Voltz eliminates painful project setup and saves hours of configuration by providing a cohesive, opinionated architecture that makes complex desktop applications easier to build and maintain.
- Node.js 18+
- npm or yarn
- Git
# Clone the repository
git clone https://github.com/voltz-team/voltz
cd voltz
# Install dependencies
npm install# Start development server with hot reload
npm run devThe application will launch with hot module replacement enabled, allowing for rapid development iteration.
# Build for all platforms
npm run build
# Platform-specific builds
npm run build:win # Windows
npm run build:mac # macOS
npm run build:linux # Linuxvoltz/
├── src/
│ ├── main/ # Electron main process
│ │ ├── core/ # Core application logic
│ │ ├── decorators/ # TypeScript decorators
│ │ ├── modules/ # Feature modules
│ │ └── utils/ # Utility functions
│ ├── preload/ # Preload scripts
│ └── renderer/ # React frontend
│ ├── components/ # Reusable UI components
│ ├── pages/ # Application pages
│ └── lib/ # Utilities and helpers
├── build/ # Build assets
├── resources/ # Application resources
└── docs/ # Documentation
Comprehensive documentation is available to help you get the most out of Voltz:
| Document | Description |
|---|---|
| 📖 Getting Started | Complete setup and first application guide |
| 🏗️ Architecture Overview | Deep dive into Voltz architecture patterns |
| ⚙️ Service System | Service creation and dependency injection |
| 🔌 IPC Communication | Type-safe inter-process communication |
| 🎨 Decorator System | Using TypeScript decorators effectively |
| 📋 Configuration Guide | Customizing your Voltz application |
| 🚀 Deployment Guide | Building and distributing your application |
| 🔧 Troubleshooting | Common issues and solutions |
| Script | Description |
|---|---|
npm run dev |
Start development with hot reload |
npm run build |
Build for production |
npm run lint |
Run ESLint code analysis |
npm run format |
Format code with Prettier |
npm run typecheck |
Run TypeScript type checking |
This project is licensed under the MIT License - see the LICENSE file for details.