Build desktop applications using Go & Web Technologies.

## Internationalization [English](README.md) | [简体中文](README.zh-Hans.md) ## Table of Contents

Click me to Open/Close the directory listing

- [1. Internationalization](#nav-1) - [2. Table of Contents](#nav-2) - [3. Introduction](#nav-3) - [3.1 Official Website](#nav-3-1) - [4. Features](#nav-4) - [5. Sponsors](#nav-5) - [6. Installation](#nav-6) - [7. FAQ](#nav-8) - [8. Contributors](#nav-9) - [9. Special Mentions](#nav-10) - [10. Special Thanks](#nav-11)

## 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!

PLEASE NOTE: As we are approaching the v2 release, we are not accepting any new feature requests or bug reports for v1. If you have a critical issue, please open a ticket and state why it is critical.

### Version 2 Wails v2 has been released in Beta for all 3 platforms. Check out the [new website](https://wails.io) if you are interested in trying it out. ### Legacy v1 Website The legacy v1 docs can be found at [https://wails.app](https://wails.app). ## 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 - 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*! ## Sponsors This project is supported by these kind people / companies:

directory

## Roadmap The project roadmap may be found [here](https://github.com/wailsapp/wails/discussions/1484). Please consult this before open up an enhancement request. ## Installation The installation instructions are on the [official website](https://wails.io/docs/gettingstarted/installation). ## FAQ - Is this an alternative to Electron? Depends on your requirements. It's designed to make it easy for Go programmers to make lightweight desktop applications or add a frontend to their existing applications. Wails v2 does offer native elements such as menus and dialogs, so it is becoming a lightweight electron alternative. - Who is this project aimed at? Go programmers who want to bundle an HTML/JS/CSS frontend with their applications, without resorting to creating a server and opening a browser to view it. - What's with the name? When I saw WebView, I thought "What I really want is tooling around building a WebView app, a bit like Rails is to Ruby". So initially it was a play on words (Webview on Rails). It just so happened to also be a homophone of the English name for the [Country](https://en.wikipedia.org/wiki/Wales) I am from. So it stuck. ## Stargazers over time [![Stargazers over time](https://starchart.cc/wailsapp/wails.svg)](https://starchart.cc/wailsapp/wails) ## Contributors 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](https://wails.io/credits#contributors). ## Special Mentions Without the following people, this project would never have existed: - [Dustin Krysak](https://wiki.ubuntu.com/bashfulrobot) - His support and feedback has been immense. More patience than you can throw a stick at (Not long now Dustin!). - [Serge Zaitsev](https://github.com/zserge) - Creator of [Webview](https://github.com/zserge/webview) which Wails uses for the windowing. - [Byron](https://github.com/bh90210) - At times, Byron has single handedly kept this project alive. Without his incredible input, we never would have got to v1. This project was mainly coded to the following albums: - [Manic Street Preachers - Resistance Is Futile](https://open.spotify.com/album/1R2rsEUqXjIvAbzM0yHrxA) - [Manic Street Preachers - This Is My Truth, Tell Me Yours](https://open.spotify.com/album/4VzCL9kjhgGQeKCiojK1YN) - [The Midnight - Endless Summer](https://open.spotify.com/album/4Krg8zvprquh7TVn9OxZn8) - [Gary Newman - Savage (Songs from a Broken World)](https://open.spotify.com/album/3kMfsD07Q32HRWKRrpcexr) - [Steve Vai - Passion & Warfare](https://open.spotify.com/album/0oL0OhrE2rYVns4IGj8h2m) - [Ben Howard - Every Kingdom](https://open.spotify.com/album/1nJsbWm3Yy2DW1KIc1OKle) - [Ben Howard - Noonday Dream](https://open.spotify.com/album/6astw05cTiXEc2OvyByaPs) - [Adwaith - Melyn](https://open.spotify.com/album/2vBE40Rp60tl7rNqIZjaXM) - [Gwidaith Hen Fran - Cedors Hen Wrach](https://open.spotify.com/album/3v2hrfNGINPLuDP0YDTOjm) - [Metallica - Metallica](https://open.spotify.com/album/2Kh43m04B1UkVcpcRa1Zug) - [Bloc Party - Silent Alarm](https://open.spotify.com/album/6SsIdN05HQg2GwYLfXuzLB) - [Maxthor - Another World](https://open.spotify.com/album/3tklE2Fgw1hCIUstIwPBJF) - [Alun Tan Lan - Y Distawrwydd](https://open.spotify.com/album/0c32OywcLpdJCWWMC6vB8v) ## Special Thanks

A huge thanks to Pace for sponsoring the project and helping the efforts to get Wails ported to Apple Silicon!

If you are looking for a Project Management tool that's powerful but quick and easy to use, check them out!

A special thank you to JetBrains for donating licenses to us!

Please click the logo to let them know your appreciation!