Skip to content

Dumpinground/sing-box-windows

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

321 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sing-Box GUI Client

Sing-Box Windows

A modern Sing-Box GUI client for Windows, Linux, and macOS built with Tauri 2.0 + Vue 3

✨ Features🚀 Installation🎯 Quick Start📸 Screenshots🛠️ Development💡 Contributing

🇨🇳 中文🇺🇸 English

GitHub release Platform Version License


🌟 About

Sing-Box GUI Client is a cutting-edge cross-platform application for Windows, Linux, and macOS that provides a modern, intuitive interface for managing Sing-Box proxy configurations. Built with the powerful combination of Tauri 2.0 and Vue 3, it offers exceptional performance, security, and user experience.

🎯 Key Highlights

  • 🚀 Blazing Fast: Built with Rust backend and optimized Vue 3 frontend
  • 💎 Modern UI: Beautiful, responsive interface with Naive UI components
  • 🔒 Secure: Rust-based backend ensures memory safety and performance
  • 🌐 Real-time: WebSocket communication for live updates
  • 🎨 Customizable: Light/Dark themes with extensive personalization options

✨ Features

🎯 Core Functionality

  • Proxy Management: Easy configuration and switching between different proxy modes
  • Subscription Management: Automatic subscription updates and management
  • Connection Monitoring: Real-time connection statistics and monitoring
  • Log Management: Comprehensive logging with filtering and search
  • Rule Management: Visual routing rule configuration and management
  • System Integration: System tray support with quick access controls

🎨 User Experience

  • Modern Interface: Clean, intuitive design based on Naive UI components
  • Multi-language Support: English, Chinese, Japanese, and Russian
  • Theme System: Light, Dark, and Auto themes with custom colors
  • Responsive Design: Optimized for various screen sizes and DPI settings

🔧 Advanced Features

  • Real-time Statistics: Live bandwidth and connection monitoring via WebSocket
  • Auto-start: Automatic system startup with delayed launch option
  • Update Management: Automatic update checking and installation
  • Memory Optimization: Efficient resource management through standard Vue.js and Pinia practices.

🚀 Installation

Download the installation package for your platform from GitHub Releases:

  • Windows: .exe installer
  • Linux: .deb package or .AppImage portable version
  • macOS: .dmg disk image or .app archive

For detailed installation instructions, please refer to the project documentation.


🎯 Quick Start

  1. Install: Download and install sing-box-windows
  2. Add Subscription: Add your subscription link in the subscription page
  3. Configure Proxy: Select a node and set proxy mode in the proxy page
  4. Start Using: Enable proxy and enjoy network access

For detailed usage tutorials, please refer to the project documentation.


📸 Screenshots

Sing-Box GUI Client Interface

Main application interface showing proxy management and system status


🛠️ Development

# Clone repository git clone https://github.com/xinggaoya/sing-box-windows.git cd sing-box-windows # Install dependencies pnpm install # Start development mode pnpm tauri dev # Build release version pnpm tauri build

For detailed development documentation, please refer to the project instructions.


🔧 Storage

The application uses local storage solutions, with all configuration and subscription data stored locally:

  • Windows: %APPDATA%\sing-box-windows\
  • Linux: ~/.local/share/sing-box-windows/
  • macOS: ~/Library/Application Support/sing-box-windows/

Data includes application settings, subscription information, theme configurations, etc., ensuring user privacy and data security.


🤝 Contributing

Welcome to submit Issues and Pull Requests!

  1. Report Issues: Submit Issue
  2. Feature Suggestions: Join Discussion
  3. Code Contributions: Fork and submit PR

🙏 Acknowledgments

  • Sing-Box - The powerful proxy core
  • Tauri - Amazing Rust-based app framework
  • Vue.js - Progressive JavaScript framework
  • Naive UI - Beautiful Vue 3 component library
  • Vite - Fast build tool and dev server


Built with ❤️ by XingGao

GitHub stars GitHub forks

📝 Disclaimer:This project is for learning and educational purposes only. All data is stored locally and will not be uploaded to the cloud.
Please comply with local laws and regulations and use this software responsibly.

About

🚀 一个优雅的 Sing-Box Windows GUI 客户端,基于 Tauri 2.0 和 Vue 3 构建。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Rust 40.3%
  • TypeScript 33.3%
  • Vue 25.2%
  • CSS 1.1%
  • Other 0.1%