wails README

The project's README from github.com/wailsapp/wails. As one markdown file: README.md.


Build desktop applications using Go & Web Technologies.

GitHub Go Reference CodeFactor Awesome Discord
Build GitHub tag (latest SemVer pre-release)

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

Table of Contents

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

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 wails.io
v3 Beta go install github.com/wailsapp/wails/v3/cmd/wails3@latest v3.wails.io

Full installation instructions are available for v2 and v3.

Sponsors

This project is supported by these kind people / companies:

Powered By

JetBrains logo.

FAQ

Stargazers over time

Wails star history chart

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

FOSSA Status

Inspiration

This project was mainly coded to the following albums:

wails (wailsapp/wails)

vuejs
Searching Database…

36.6K ·GitHub
What is this?Wails is a framework for building desktop apps with Go: it wraps your Go backend and a web frontend into a single binary, with tooling for creating, compiling and bundling the project.
Is it a framework or just a library?A framework — it ships a powerful CLI that scaffolds new projects and handles compilation and bundling, not just code you import.
Do I have to build the UI with a specific frontend stack?No — any frontend tech you already know works, with pre-built templates for React, Vue, Svelte, Angular and others.
Does it bundle a browser like Electron?No. It renders through the operating system's native web engine instead of shipping an embedded browser, which keeps apps lightweight.
Is it for Go developers specifically?Primarily yes: it targets Go programmers who want an HTML/JS/CSS frontend bundled into their app without running a server and opening a browser to view it.
Can I ship the same app on Windows, macOS and Linux?Yes — it's multiplatform, so one Go backend plus a web frontend covers Windows, macOS and Linux.
How does it compare to Electron?The author calls it a lightweight Electron alternative for Go developers: it offers native elements like menus and dialogs, but whether it fits depends on your requirements.
Can JavaScript talk to my Go code?Yes — you can call Go methods directly from Javascript, Wails auto-generates Typescript definitions for your Go structs and methods, and events are unified between the two sides.
What is the state of v2 versus v3?v2 is stable and documented at wails.io; v3 is in beta, installs as 'wails3' and has its own docs at v3.wails.io.
Why is it called Wails?It began as a pun on 'Webview on Rails' — tooling around webview apps the way Rails serves Ruby — and also happens to be a homophone of the country the author is from.
Creator
wailsapp
Size
508.4 MB
Stars
36.6K
Age
7y
Commits · 90 Days