github.com/AlpineAIO/wails/v2@v2.0.0-beta.32.0.20240505041856-1047a8fa5fef/README.md (about) 1 <p align="center" style="text-align: center"> 2 <img src="../assets/images/logo-universal.png" width="55%"><br/> 3 </p> 4 5 <p align="center"> 6 Build desktop applications using Go & Web Technologies. 7 <br/> 8 <br/> 9 <a href="https://github.com/AlpineAIO/wails/blob/master/LICENSE"> 10 <img alt="GitHub" src="https://img.shields.io/github/license/wailsapp/wails"/> 11 </a> 12 <a href="https://goreportcard.com/report/github.com/AlpineAIO/wails"> 13 <img src="https://goreportcard.com/badge/github.com/AlpineAIO/wails" /> 14 </a> 15 <a href="https://pkg.go.dev/github.com/AlpineAIO/wails"> 16 <img src="https://pkg.go.dev/badge/github.com/AlpineAIO/wails.svg" alt="Go Reference"/> 17 </a> 18 <a href="https://github.com/AlpineAIO/wails/issues"> 19 <img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="CodeFactor" /> 20 </a> 21 <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fwailsapp%2Fwails?ref=badge_shield" alt="FOSSA Status"> 22 <img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwailsapp%2Fwails.svg?type=shield" /> 23 </a> 24 <a href="https://github.com/avelino/awesome-go" rel="nofollow"> 25 <img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome" /> 26 </a> 27 <br/> 28 <a href="https://github.com/AlpineAIO/wails/actions/workflows/build.yml" rel="nofollow"> 29 <img src="https://img.shields.io/github/workflow/status/wailsapp/wails/Build?logo=github" alt="Build" /> 30 </a> 31 <a href="https://github.com/AlpineAIO/wails/tags" rel="nofollow"> 32 <img alt="GitHub tag (latest SemVer pre-release)" src="https://img.shields.io/github/v/tag/wailsapp/wails?include_prereleases&label=version"/> 33 </a> 34 </p> 35 36 <div align="center"> 37 <strong> 38 <samp> 39 40 [English](README.md) · [简体中文](README.zh-Hans.md) · [日本語](README.ja.md) 41 42 </samp> 43 </strong> 44 </div> 45 46 ## Table of Contents 47 48 <details> 49 <summary>Click me to Open/Close the directory listing</summary> 50 51 - [Table of Contents](#table-of-contents) 52 - [Introduction](#introduction) 53 - [Roadmap](#roadmap) 54 - [Features](#features) 55 - [Sponsors](#sponsors) 56 - [Getting Started](#getting-started) 57 - [FAQ](#faq) 58 - [Contributors](#contributors) 59 - [License](#license) 60 61 </details> 62 63 ## Introduction 64 65 The traditional method of providing web interfaces to Go programs is via a 66 built-in web server. Wails offers a different approach: it provides the ability 67 to wrap both Go code and a web frontend into a single binary. Tools are provided 68 to make this easy for you by handling project creation, compilation and 69 bundling. All you have to do is get creative! 70 71 ## Features 72 73 - Use standard Go for the backend 74 - Use any frontend technology you are already familiar with to build your UI 75 - Quickly create rich frontends for your Go programs using pre-built templates 76 - Easily call Go methods from Javascript 77 - Auto-generated Typescript definitions for your Go structs and methods 78 - Native Dialogs & Menus 79 - Native Dark / Light mode support 80 - Supports modern translucency and "frosted window" effects 81 - Unified eventing system between Go and Javascript 82 - Powerful cli tool to quickly generate and build your projects 83 - Multiplatform 84 - Uses native rendering engines - _no embedded browser_! 85 86 ### Roadmap 87 88 The project roadmap may be found 89 [here](https://github.com/AlpineAIO/wails/discussions/1484). Please consult this 90 before open up an enhancement request. 91 92 ## Sponsors 93 94 This project is supported by these kind people / companies: 95 96 <a href="https://github.com/sponsors/leaanthony" style="width:100px;"> 97 <img src="../website/static/img/silver%20sponsor.webp" width="100"/> 98 </a> 99 <a href="https://github.com/selvindev" style="width:100px;"> 100 <img src="https://github.com/selvindev.png?size=100" width="100"/> 101 </a> 102 <br/> 103 <br/> 104 <a href="https://github.com/sponsors/leaanthony" style="width:100px;"> 105 <img src="../website/static/img/bronze%20sponsor.webp" width="100"/> 106 </a> 107 108 <a href="https://github.com/codydbentley" style="width:100px"> 109 <img src="https://github.com/codydbentley.png?size=100" width="100"/> 110 </a> 111 <a href="https://www.easywebadv.it/" style="width:100px"> 112 <img src="../website/static/img/easyweb.png" width="100"/> 113 </a> 114 <br/> 115 <br/> 116 <a href="https://github.com/matryer" style="width:100px"> 117 <img src="https://github.com/matryer.png" width="100"/> 118 </a> 119 <a href="https://github.com/tc-hib" style="width:55px"> 120 <img src="https://github.com/tc-hib.png?size=55" width="55"/> 121 </a> 122 <a href="https://github.com/picatz" style="width:50px"> 123 <img src="https://github.com/picatz.png?size=50" width="50"/> 124 </a> 125 <a href="https://github.com/tylertravisty" style="width:50px"> 126 <img src="https://github.com/tylertravisty.png?size=50" width="50"/> 127 </a> 128 <a href="https://github.com/akhudek" style="width:50px"> 129 <img src="https://github.com/akhudek.png?size=50" width="50"/> 130 </a> 131 <a href="https://github.com/trea" style="width:50px"> 132 <img src="https://github.com/trea.png?size=50" width="50"/> 133 </a> 134 <a href="https://github.com/fcjr" style="width:55px"> 135 <img src="https://github.com/fcjr.png?size=55" width="55"/> 136 </a> 137 <a href="https://github.com/nickarellano" style="width:60px"> 138 <img src="https://github.com/nickarellano.png?size=60" width="60"/> 139 </a> 140 <a href="https://github.com/bglw" style="width:65px"> 141 <img src="https://github.com/bglw.png?size=65" width="65"/> 142 </a> 143 <a href="https://github.com/marcus-crane" style="width:65px"> 144 <img src="https://github.com/marcus-crane.png?size=65" width="65"/> 145 </a> 146 <a href="https://github.com/bbergshaven" style="width:45px"> 147 <img src="https://github.com/bbergshaven.png?size=45" width="45"/> 148 </a> 149 <a href="https://github.com/ilgityildirim" style="width:50px"> 150 <img src="https://github.com/ilgityildirim.png?size=50" width="50"/> 151 </a> 152 <a href="https://github.com/questrail" style="width:50px"> 153 <img src="https://github.com/questrail.png?size=50" width="50"/> 154 </a> 155 <a href="https://github.com/DonTomato" style="width:45px"> 156 <img src="https://github.com/DonTomato.png?size=45" width="45"/> 157 </a> 158 <a href="https://github.com/taigrr" style="width:55px"> 159 <img src="https://github.com/taigrr.png?size=55" width="55"/> 160 </a> 161 <a href="https://github.com/charlie-dee" style="width:55px"> 162 <img src="https://github.com/charlie-dee.png?size=55" width="55"/> 163 </a> 164 <a href="https://github.com/michaelolson1996" style="width:55px"> 165 <img src="https://github.com/michaelolson1996.png?size=55" width="55"/> 166 </a> 167 <a href="https://github.com/GargantuaX" style="width:45px"> 168 <img src="https://github.com/GargantuaX.png?size=45" width="45"/> 169 </a> 170 <a href="https://github.com/CharlieGo88" style="width:55px"> 171 <img src="https://github.com/CharlieGo88.png?size=55" width="55"/> 172 </a> 173 <a href="https://github.com/Shackelford-Arden" style="width:55px"> 174 <img src="https://github.com/Shackelford-Arden.png?size=55" width="55"/> 175 </a> 176 <a href="https://github.com/boostchicken" style="width:65px"> 177 <img src="https://github.com/boostchicken.png?size=65" width="65"/> 178 </a> 179 <a href="https://github.com/iansinnott" style="width:55px"> 180 <img src="https://github.com/iansinnott.png?size=55" width="55"/> 181 </a> 182 <a href="https://github.com/Ilshidur" style="width:50px"> 183 <img src="https://github.com/Ilshidur.png?size=50" width="50"/> 184 </a> 185 <a href="https://github.com/KiddoV" style="width:45px"> 186 <img src="https://github.com/KiddoV.png?size=45" width="45"/> 187 </a> 188 189 ## Getting Started 190 191 The installation instructions are on the 192 [official website](https://wails.io/docs/gettingstarted/installation). 193 194 ## FAQ 195 196 - Is this an alternative to Electron? 197 198 Depends on your requirements. It's designed to make it easy for Go programmers 199 to make lightweight desktop applications or add a frontend to their existing 200 applications. Wails does offer native elements such as menus and dialogs, so 201 it could be considered a lightweight electron alternative. 202 203 - Who is this project aimed at? 204 205 Go programmers who want to bundle an HTML/JS/CSS frontend with their 206 applications, without resorting to creating a server and opening a browser to 207 view it. 208 209 - What's with the name? 210 211 When I saw WebView, I thought "What I really want is tooling around building a 212 WebView app, a bit like Rails is to Ruby". So initially it was a play on words 213 (Webview on Rails). It just so happened to also be a homophone of the English 214 name for the [Country](https://en.wikipedia.org/wiki/Wales) I am from. So it 215 stuck. 216 217 ## Stargazers over time 218 219 [](https://starchart.cc/wailsapp/wails) 220 221 ## Contributors 222 223 The contributors list is getting too big for the readme! All the amazing people 224 who have contributed to this project have their own page 225 [here](https://wails.io/credits#contributors). 226 227 ## License 228 229 [](https://app.fossa.com/projects/git%2Bgithub.com%2Fwailsapp%2Fwails?ref=badge_large) 230 231 ## Inspiration 232 233 This project was mainly coded to the following albums: 234 235 - [Manic Street Preachers - Resistance Is Futile](https://open.spotify.com/album/1R2rsEUqXjIvAbzM0yHrxA) 236 - [Manic Street Preachers - This Is My Truth, Tell Me Yours](https://open.spotify.com/album/4VzCL9kjhgGQeKCiojK1YN) 237 - [The Midnight - Endless Summer](https://open.spotify.com/album/4Krg8zvprquh7TVn9OxZn8) 238 - [Gary Newman - Savage (Songs from a Broken World)](https://open.spotify.com/album/3kMfsD07Q32HRWKRrpcexr) 239 - [Steve Vai - Passion & Warfare](https://open.spotify.com/album/0oL0OhrE2rYVns4IGj8h2m) 240 - [Ben Howard - Every Kingdom](https://open.spotify.com/album/1nJsbWm3Yy2DW1KIc1OKle) 241 - [Ben Howard - Noonday Dream](https://open.spotify.com/album/6astw05cTiXEc2OvyByaPs) 242 - [Adwaith - Melyn](https://open.spotify.com/album/2vBE40Rp60tl7rNqIZjaXM) 243 - [Gwidaith Hen Fran - Cedors Hen Wrach](https://open.spotify.com/album/3v2hrfNGINPLuDP0YDTOjm) 244 - [Metallica - Metallica](https://open.spotify.com/album/2Kh43m04B1UkVcpcRa1Zug) 245 - [Bloc Party - Silent Alarm](https://open.spotify.com/album/6SsIdN05HQg2GwYLfXuzLB) 246 - [Maxthor - Another World](https://open.spotify.com/album/3tklE2Fgw1hCIUstIwPBJF) 247 - [Alun Tan Lan - Y Distawrwydd](https://open.spotify.com/album/0c32OywcLpdJCWWMC6vB8v)