leon3s / wireguard-gui

A wireguard client GUI for Debian/Linux made with nextauri
Apache License 2.0
34 stars 2 forks source link

Wireguard GUI

❤️ Made with love with Nextauri ❤️

[![Stars](https://img.shields.io/github/stars/leon3s/wireguard-gui?style=social)](https://github.com/leon3s/wireguard-gui) [![Rust](https://img.shields.io/badge/built_with-Rust-dca282.svg)](https://github.com/leon3s/wireguard-gui) [![Typescript](https://img.shields.io/badge/built_with-Typescript-3178C6.svg)](https://github.com/leon3s/wireguard-gui) [![Discord](https://img.shields.io/discord/1011267493114949693?label=chat&logo=discord)](https://discord.gg/WV4Aac8uZg)

[![Eslint & Clippy](https://github.com/leon3s/wireguard-gui/actions/workflows/eslint_clippy.yml/badge.svg)](https://github.com/leon3s/wireguard-gui/actions/workflows/eslint_clippy.yml) [![Build](https://github.com/leon3s/wireguard-gui/actions/workflows/build.yml/badge.svg)](https://github.com/leon3s/wireguard-gui/actions/workflows/build.yml)

❓ What is Wireguard GUI ?

Wireguard GUI is a Debian/Linux application that allow you to manage your Wireguard VPN configuration.

💡 Features

💪 Motivation

I didn't found any GUI application that allow me to manage my Wireguard VPN configuration.
I wanted to make an application with nextauri since a while, so i took this opportunity to make it.

📦 Installation

Release are currently only available as a .deb package for Debian/Ubuntu. It can be found on the release page

🚀 Demo

A demo will be recorded soon.

🎨 Developing

Be sure you have NodeJS and Rust installed on your system

  1. See Tauri prerequisites to prepare your system to build Tauri

  2. Clone or fork this repository

    git clone https://github.com/leon3s/wireguard-gui
    cd wireguard-gui
  3. Install node dependencies

    npm install

To get started you only need one command

npm run dev

⚡Production

To build in production you can do it in a single command. This will build and export Next.js and build Tauri for your current environnement.

npm run tauri build

📚 Documentation

To learn more about Tauri and Next.js, take a look at the following resources: