wailsapp/wails: Create beautiful applications using Go

Build desktop applications using Go & Web Technologies.

Table of Contents

• Table of Contents
• Introduction
• Features

• Getting Started
• Sponsors
• FAQ
• Stargazers over time
• Contributors
• License
• Inspiration

Introduction

The traditional method of providing web interfaces to Go programs is via a built-in web server. Wails offers a different approach: it provides the ability to wrap both Go code and a web frontend into a single binary. Tools are provided to make this easy for you by handling project creation, compilation and bundling. All you have to do is get creative!

Features

• Use standard Go for the backend
• Use any frontend technology you are already familiar with to build your UI
• Quickly create rich frontends for your Go programs using pre-built templates
• Easily call Go methods from Javascript
• Auto-generated Typescript definitions for your Go structs and methods
• Native Dialogs & Menus
• Native Dark / Light mode support
• Supports modern translucency and "frosted window" effects
• Unified eventing system between Go and Javascript
• Powerful cli tool to quickly generate and build your projects
• Multiplatform
• Uses native rendering engines - _no embedded browser_!

Roadmap

The project roadmap may be found here. New functionality and public behaviour changes use a WEP (Wails Enhancement Proposal), submitted as a draft pull request rather than a feature-request issue.

Getting Started

Wails has two active versions:

| Version | Status | Install | Docs | |---|---|---|---| | v2 | Stable | go install github.com/wailsapp/wails/v2/cmd/wails@latest | v2.wails.io | | v3.0.0 | Stable | go install github.com/wailsapp/wails/v3/cmd/[email protected] | wails.io |

Full installation instructions are available for v2 and v3.

Sponsors

This project is supported by these kind people / companies:

Powered By

Thanks to CodeRabbit for supporting Wails with AI code reviews.

FAQ

• Is this an alternative to Electron?

• Who is this project aimed at?

• What's with the name?

Stargazers over time

Contributors

To improve the v3 documentation, follow Write documentation with M-Press for downloads, installation, preview and submitting a PR.

The contributors list is getting too big for the readme! All the amazing people who have contributed to this project have their own page here.

License

• Manic Street Preachers - Resistance Is Futile
• Manic Street Preachers - This Is My Truth, Tell Me Yours
• The Midnight - Endless Summer
• Gary Newman - Savage (Songs from a Broken World)
• Steve Vai - Passion & Warfare
• Ben Howard - Every Kingdom
• Ben Howard - Noonday Dream
• Adwaith - Melyn
• Gwidaith Hen Fran - Cedors Hen Wrach
• Metallica - Metallica
• Bloc Party - Silent Alarm
• Maxthor - Another World
• Alun Tan Lan - Y Distawrwydd