wails – wailsapp

<p align="center" style="text-align: center">
<img src="./assets/images/logo-universal.png" width="55%"><br/>
</p>

<p align="center">
Build desktop applications using Go & Web Technologies.
<br/>
<br/>
<a href="https://github.com/wailsapp/wails/blob/master/LICENSE">
<img alt="GitHub" src="https://img.shields.io/github/license/wailsapp/wails"/>
</a>
<a href="https://goreportcard.com/report/github.com/wailsapp/wails">
<img src="https://goreportcard.com/badge/github.com/wailsapp/wails" />
</a>
<a href="https://pkg.go.dev/github.com/wailsapp/wails">
<img src="https://pkg.go.dev/badge/github.com/wailsapp/wails.svg" alt="Go Reference"/>
</a>
<a href="https://github.com/wailsapp/wails/issues">
<img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="CodeFactor" />
</a>
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fwailsapp%2Fwails?ref=badge_shield" alt="FOSSA Status">
<img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwailsapp%2Fwails.svg?type=shield" />
</a>
<a href="https://github.com/avelino/awesome-go" rel="nofollow">
<img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome" />
</a>
<a href="https://discord.gg/BrRSWTaxVK">
<img alt="Discord" src="https://img.shields.io/discord/1042734330029547630?logo=discord"/>
</a>
<br/>
<a href="https://github.com/wailsapp/wails/actions/workflows/build-and-test.yml" rel="nofollow">
<img src="https://img.shields.io/github/actions/workflow/status/wailsapp/wails/build-and-test.yml?branch=master&logo=Github" alt="Build" />
</a>
<a href="https://github.com/wailsapp/wails/tags" rel="nofollow">
<img alt="GitHub tag (latest SemVer pre-release)" src="https://img.shields.io/github/v/tag/wailsapp/wails?include_prereleases&label=version"/>
</a>
</p>

<div align="center">
<strong>
<samp>

English · 简体中文 · 日本語 ·
한국어 · Español · Português ·
Русский · Francais · Uzbek · Deutsch ·
Türkçe · Bahasa Indonesia

</samp>
</strong>
</div>

Table of Contents

• Table of Contents
• Introduction
• Features
• Roadmap
• 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:

Full installation instructions are available for v2 and v3.

Sponsors

This project is supported by these kind people / companies:
<img src="website/static/img/sponsors.svg" style="width:100%;max-width:800px;"/>

Powered By

<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg" alt="JetBrains logo." class="ra0-md-img" loading="lazy" />

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 does offer native elements such as menus
and dialogs, so it could be considered 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 I am from. So it stuck.

Stargazers over time

<a href="https://github.com/wailsapp/wails/stargazers">
<img alt="Wails star history chart" src="website/static/img/star-history.svg" width="800" />
</a>

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.

License

<img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwailsapp%2Fwails.svg?type=large" alt="FOSSA Status" class="ra0-md-img" loading="lazy" />

Inspiration

This project was mainly coded to the following albums:

• 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