[v2] Docs update

2026-08-05 13:53:43 -07:00 · 2021-09-27 19:35:30 +10:00
parent 511d0da2cb
commit 589eb3864f
150 changed files with 19195 additions and 0 deletions
@@ -0,0 +1,70 @@
+---
+sidebar_position: 1
+---
+
+# About
+
+## Overview
+
+Wails is a project that enables you to write desktop apps using Go and web technologies.
+
+Consider it a lightweight and fast Electron alternative for Go. You can easily build applications with the flexibility
+and power of Go, combined with a rich, modern frontend.
+
+Wails doesn't hold back with the eye candy either! This is [xbar](https://xbarapp.com) - a desktop application for MacOS
+written using Wails. It has menus, supports light and dark desktop themes, and the main window uses translucency that
+gives it that 'frosty' effect of a native app.
+
+<p class="text--center">
+<a href="https://xbarapp.com"><img src="/img/xbar-app-preview-2.png" width="75%"/></a>
+</p>
+
+## Native Elements
+
+Wails uses a purpose built library for handling native elements such as Window, Menus, Dialogs, etc, so you can build
+good-looking, feature rich desktop applications.
+
+**It does not embed a browser**, so it is resource efficient. Instead, it uses the native rendering engine for the
+platform. On Windows, this is the new Microsoft Webview2 library, built on Chromium.
+
+## Go & Javascript Interoperability
+
+Wails automatically makes your Go methods available to Javascript, so you can call them by name from your frontend!
+It even generates Typescript versions of the structs used by your Go methods, so you can pass the same data structures
+between Go and Javascript.
+
+## Runtime Library
+
+Wails provides a runtime library, for both Go and Javascript, that handles a lot of the things modern applications need,
+like Eventing, Logging, Dialogs, etc.
+
+## Live Development Experience
+
+### Automatic Rebuilds
+
+When you run your application in "dev" mode, Wails will build your application as a native desktop application, but will
+read your assets from disk. It will detect any changes to your Go code and automatically rebuild and relaunch your
+application.
+
+### Automatic Reloads
+
+When changes to your application assets are detected, your running application will "reload", reflecting your changes
+almost immediately.
+
+### Develop your application in a Browser
+
+If you prefer to debug and develop in a browser then Wails has you covered. The running application also has a webserver
+that will run your application in any browser that connects to it. It will even refresh when your assets change on disk.
+
+## Production-ready Native Binaries
+
+When you're ready to do the final build of your application, the CLI will compile it down to a single executable, with
+all the assets bundled into it. On Windows and MacOS, it is possible to create a native package for distribution. The
+assets used in packaging (icon, info.plist, manifest file, etc) are part of your project and may be customised, giving
+you total control over how your applications are built.
+
+## Tooling
+
+The Wails CLI provides a hassle-free way to generate, build and bundle your applications. It will do the heavy lifting
+of creating icons, compiling your application with optimal settings and delivering a distributable, production ready
+binary. Choose from a number of starter templates to get up and running quickly!
@@ -0,0 +1,4 @@
+{
+  "label": "Community",
+  "position": 50
+}
@@ -0,0 +1,19 @@
+---
+sidebar_position: 2
+---
+
+# Links
+
+This page serves as a list for community related links. Please submit a PR (click `Edit this page` at the bottom)
+to submit links.
+
+## Support Channels
+
+ - [Gophers Slack Channel](https://gophers.slack.com/messages/CJ4P9F7MZ/)
+ - [Gophers Slack Channel Invite](https://invite.slack.golangbridge.org/)
+ - [Github Issues](https://github.com/wailsapp/wails/issues)
+ - [v2 Beta Discussion Board](https://github.com/wailsapp/wails/discussions)
+
+## Social Media
+
+ - [Twitter](https://twitter.com/wailsapp)
@@ -0,0 +1,4 @@
+{
+  "label": "Showcase",
+  "position": 1
+}
@@ -0,0 +1,10 @@
+
+# EncryptEasy
+
+<p style={{"text-align": "center"}}>
+   <img src="encrypteasy.jpg"></img><br/>
+</p>
+
+**[EncryptEasy](https://www.encrypteasy.app) is a simple and easy to use PGP encryption tool, managing all your and your contacts keys. Encryption should be simple. Developed with Wails.**
+
+Encrypting messages using PGP is the industry standard. Everyone has a private and a public key. Your private key, well, needs to be kept private so only you can read messages. Your public key is distributed to anyone who wants to send you secret, encrypted messages. Managing keys, encrypting messages and decrypting messages should be a smooth experience. EncryptEasy is all about making it easy.
@@ -0,0 +1,23 @@
+
+# FileHound Export Utility
+
+<p style={{"text-align": "center"}}>
+   <img src="filehound.jpg"></img><br/>
+</p>
+
+
+[FileHound Export Utility](https://www.filehound.co.uk/) FileHound is a cloud document management platform made for secure file retention, business process automation and SmartCapture capabilities.
+
+The FileHound Export Utility allows FileHound Administrators the ability to run a secure document and data extraction tasks for alternative back-up and recovery purposes. This application will download all documents and/or meta data saved in FileHound based on the filters you choose. The metadata will be exported in both JSON and XML formats.
+
+Backend built with:
+Go 1.15
+Wails 1.11.0
+go-sqlite3 1.14.6
+go-linq 3.2
+
+Frontend with:
+Vue 2.6.11
+Vuex 3.4.0
+Typescript
+Tailwind 1.9.6
@@ -0,0 +1,9 @@
+
+# Molley Wallet
+
+<p style={{"text-align": "center"}}>
+   <img src="mollywallet.png"></img><br/>
+</p>
+
+[Molly Wallet](https://github.com/grvlle/constellation_wallet/) the official $DAG wallet of the Constellation Network. It'll let users interact with the Hypergraph Network in various ways, not limited to producing $DAG transactions.
+
@@ -0,0 +1,9 @@
+
+# Optimus
+
+<p style={{"text-align": "center"}}>
+   <img src="optimus.png"></img><br/>
+</p>
+
+[Optimus](https://github.com/splode/optimus) is a desktop image optimization application. It supports conversion and compression between WebP, JPEG, and PNG image formats.
+
@@ -0,0 +1,9 @@
+
+# Portfall
+
+<p style={{"text-align": "center"}}>
+   <img src="portfall.gif"></img><br/>
+</p>
+
+[Portfall](https://github.com/rekon-oss/portfall) - A desktop k8s port-forwarding portal for easy access to all your cluster UIs
+
@@ -0,0 +1,9 @@
+
+# Surge
+
+<p style={{"text-align": "center"}}>
+   <img src="surge.png"></img><br/>
+</p>
+
+[Surge](https://surge.rule110.io/) is a p2p filesharing app designed to utilize blockchain technologies to enable 100% anonymous file transfers. Surge is end-to-end encrypted, decentralized and open source.
+
@@ -0,0 +1,9 @@
+
+# Wally
+
+<p style={{"text-align": "center"}}>
+   <img src="wally.png"></img><br/>
+</p>
+
+[Wally](https://ergodox-ez.com/pages/wally) is the official firmware flasher for [Ergodox](https://ergodox-ez.com/) keyboards. It looks great and is a fantastic example of what you can achieve with Wails: the ability to combine the power of Go and the rich graphical tools of the web development world.
+
@@ -0,0 +1,10 @@
+
+# Wombat
+
+<p style={{"text-align": "center"}}>
+   <img src="wombat.png"></img><br/>
+</p>
+
+
+[Wombat](https://github.com/rogchap/wombat) is a cross platform gRPC client.
+
--- a/Show More
+++ b/Show More