Skip to content
Create desktop apps using Go and Web Technologies
Branch: master
Clone or download
Latest commit 39ea5cc May 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.chglog docs: added changelog May 12, 2019
.github/ISSUE_TEMPLATE Update bug_report.md May 23, 2019
.vscode vscode settings Apr 25, 2019
cmd chore: version bump May 12, 2019
licenses updated licenses + gomod Feb 20, 2019
scripts chore: improve updateversion.sh May 2, 2019
wailsruntimeassets Set script type for injections Apr 22, 2019
.gitignore Automate version bumps Mar 10, 2019
.goreleaser.yml release 0.11.3 Apr 25, 2019
CHANGELOG.md docs: added changelog May 12, 2019
CONTRIBUTORS.md docs: updated contributors May 12, 2019
LICENSE Update license and readme Apr 8, 2019
README.md Update README.md May 19, 2019
app.go fix: ensure errors are logged Apr 25, 2019
app_cli.go fix: version output of built app Mar 28, 2019
app_config.go Fix HTML spelling in app_config.go May 1, 2019
binding_function.go fix: convert js nulls to Go zero values Mar 18, 2019
binding_manager.go refactored processCall Feb 4, 2019
binding_method.go Args messages to debug Jan 10, 2019
event_manager.go linting fixes Apr 9, 2019
go.mod chore: update go mod files May 12, 2019
go.sum chore: update go mod files May 12, 2019
ipc_call.go Initial commit of wails build Jan 7, 2019
ipc_event.go Initial commit of wails build Jan 7, 2019
ipc_log.go Initial commit of wails build Jan 7, 2019
ipc_manager.go Initial commit of wails build Jan 7, 2019
ipc_message.go Initial commit of wails build Jan 7, 2019
ipc_response.go Use hex encoded strings for callbacks Mar 17, 2019
log.go Added release mode flag Jan 10, 2019
log_custom.go Added release mode flag Jan 10, 2019
renderer.go Initial commit of simplification Jan 29, 2019
renderer_headless.go dialog errors -> warnings Apr 27, 2019
renderer_webview.go more linting fixes Apr 9, 2019
runtime.go Added Runtime.FileSystem Apr 20, 2019
runtime_dialog.go Updated comments Jan 14, 2019
runtime_events.go fix: destructure emit data Apr 22, 2019
runtime_filesystem.go Added Runtime.FileSystem Apr 20, 2019
runtime_log.go Updated comments Jan 14, 2019
runtime_window.go Updated comments Jan 14, 2019
utils.go Move to mewn Feb 17, 2019
wails-mewn.go more linting fixes Apr 9, 2019

README.md


A framework for building desktop applications using Go & Web Technologies.

CodeFactor CodeFactor Awesome

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 libraries/frameworks for the backend
  • Use any frontend technology to build your UI
  • Expose Go methods/functions to the frontend via a single bind command
  • Uses native rendering engines - no embedded browser
  • Shared events system
  • Native file dialogs
  • Powerful cli tool
  • Multiplatform

Project Status

Wails is currently in Beta. Please make sure you read the Project Status if you are interested in using this project.

Installation

Wails uses cgo to bind to the native rendering engines so a number of platform dependent libraries are needed as well as an installation of Go. The basic requirements are:

  • Go 1.11 or above
  • npm

MacOS

Make sure you have the xcode command line tools installed. This can be done by running:

xcode-select --install

Linux

Ubuntu 18.04

sudo apt install pkg-config build-essential libgtk-3-dev libwebkit2gtk-4.0-dev

Arch Linux

sudo pacman -S webkit2gtk gtk3

Red Hat Based Distros

sudo yum install webkit2gtk-devel gtk3-devel

Note: If you have successfully installed these dependencies on a different flavour of Linux, please consider submitting a PR.

Windows

Windows requires gcc and related tooling. The recommended download is from http://tdm-gcc.tdragon.net/download. Once this is installed, you are good to go.

Installation

Ensure Go modules are enabled: GO111MODULE=on and go/bin is in your PATH variable.

Installation is as simple as running the following command:

go get github.com/wailsapp/wails/cmd/wails

Next Steps

It is recommended at this stage to read the comprehensive documentation at https://wails.app.

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. Whilst Wails does not currently offer hooks into native elements such as menus, this may change in the future.

  • 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.

Shoulders of Giants

Without the following people, this project would never have existed:

  • Dustin Krysak - His support and feedback has been immense. More patience than you can throw a stick at (Not long now Dustin!).
  • Serge Zaitsev - Creator of Webview which Wails uses for the windowing.

And without these people, it wouldn't be what it is today.

Special Mentions:

  • Bill Kennedy - Go guru, encourager and all-round nice guy, whose infectious energy and inspiration powered me on when I had none left.
  • Mark Bates - Creator of Packr, inspiration for packing strategies which fed into some of the tooling.

This project was mainly coded to the following albums:

You can’t perform that action at this time.