wails

package module
v2.6.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 21, 2023 License: MIT Imports: 3 Imported by: 0

README


Build desktop applications using Go & Web Technologies.

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

Table of Contents

Click me to Open/Close the directory listing

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. Please consult this before open up an enhancement request.

Sponsors

This project is supported by these kind people / companies:





Getting Started

The installation instructions are on the official website.

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

Stargazers over time

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:

Documentation

Overview

Package wails is the main package of the Wails project. It is used by client applications.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Run

func Run(options *options.App) error

Run creates an application based on the given config and executes it

Types

This section is empty.

Directories

Path Synopsis
cmd
internal
app
frontend/desktop/windows/winc
* Copyright (C) 2019 The Winc Authors.
* Copyright (C) 2019 The Winc Authors.
frontend/desktop/windows/winc/w32
* Copyright (C) 2019 The Winc Authors.
* Copyright (C) 2019 The Winc Authors.
fs
go-common-file-dialog/cfd
Common File Dialogs
Common File Dialogs
s
pkg
assetserver
Code from https://github.com/erikdubbelboer/ringqueue
Code from https://github.com/erikdubbelboer/ringqueue
git
mac
Package mac provides MacOS related utility functions for Wails applications
Package mac provides MacOS related utility functions for Wails applications
menu
Package menu provides all the functions and structs related to menus in a Wails application.
Package menu provides all the functions and structs related to menus in a Wails application.
tools

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL