2021-12-26 02:31:55 +08:00
< h1 align = "center" >
< img src = "./src/assets/image/logo.png" alt = "Clash" width = "128" / >
< br >
Clash Verge
< br >
< / h1 >
2021-12-04 14:31:26 +08:00
2021-12-26 02:31:55 +08:00
< h3 align = "center" >
A < a href = "https://github.com/Dreamacro/clash" > Clash< / a > GUI based on < a href = "https://github.com/tauri-apps/tauri" > tauri< / a > .
< / h3 >
2021-12-04 14:31:26 +08:00
2021-12-26 02:31:55 +08:00
## Features
2022-03-18 19:02:53 +08:00
- Full `clash` config supported, Partial `clash premium` config supported.
- Profiles management and enhancement (by yaml and Javascript).
- System proxy setting and guard.
## Install
2022-03-21 21:55:45 +08:00
Download from [release ](https://github.com/zzzgydi/clash-verge/releases ). Supports Windows x64, Linux x86_64 and macOS 11+
2022-03-18 19:02:53 +08:00
Or you can build it yourself. Supports Windows, Linux and macOS 10.15+
Notes: If you could not start the app on Windows, please check that you have [Webview2 ](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section ) installed.
2021-12-26 02:31:55 +08:00
## Development
2022-02-22 21:54:33 +08:00
You should install Rust and Nodejs, see [here ](https://tauri.studio/docs/getting-started/prerequisites ) for more details. Then install Nodejs packages.
2021-12-26 02:31:55 +08:00
```shell
yarn install
```
2022-02-22 21:54:33 +08:00
Then download the clash binary... Or you can download it from [clash premium release ](https://github.com/Dreamacro/clash/releases/tag/premium ) and rename it according to [tauri config ](https://tauri.studio/docs/api/config/#tauri.bundle.externalBin ).
2021-12-26 02:31:55 +08:00
```shell
2022-01-10 02:49:42 +08:00
yarn run check
2021-12-26 02:31:55 +08:00
```
Then run
```shell
yarn dev
```
2022-03-18 19:02:53 +08:00
Or you can build it
```shell
yarn build
```
2021-12-26 02:31:55 +08:00
## Todos
> This keng is a little big...
## Screenshots
< div align = "center" >
2022-01-10 02:52:12 +08:00
< img src = "./docs/demo1.png" alt = "demo1" width = "32%" / >
< img src = "./docs/demo2.png" alt = "demo2" width = "32%" / >
< img src = "./docs/demo3.png" alt = "demo3" width = "32%" / >
< img src = "./docs/demo4.png" alt = "demo4" width = "32%" / >
< img src = "./docs/demo5.png" alt = "demo5" width = "32%" / >
< img src = "./docs/demo6.png" alt = "demo6" width = "32%" / >
2021-12-26 02:31:55 +08:00
< / div >
## Disclaimer
This is a learning project for Rust practice.
## Contributions
2022-02-22 21:54:33 +08:00
Issue and PR welcome!
2021-12-26 02:31:55 +08:00
2022-01-22 23:57:39 +08:00
## Acknowledgement
Clash Verge was based on or inspired by these projects and so on:
- [tauri-apps/tauri ](https://github.com/tauri-apps/tauri ): Build smaller, faster, and more secure desktop applications with a web frontend.
- [Dreamacro/clash ](https://github.com/Dreamacro/clash ): A rule-based tunnel in Go.
- [Fndroid/clash_for_windows_pkg ](https://github.com/Fndroid/clash_for_windows_pkg ): A Windows/macOS GUI based on Clash.
- [vitejs/vite ](https://github.com/vitejs/vite ): Next generation frontend tooling. It's fast!
2021-12-26 02:31:55 +08:00
## License
2022-01-22 23:57:39 +08:00
GPL-3.0 License. See [License here ](./LICENSE ) for details.
