README

ui demo

app

Circle CI Go build Go Report Card GoDoc

A WebAssembly framework to build GUI with Go, HTML and CSS.

It features:

Install

Requires Go 1.13

# Package sources + goapp CLI:
go get -u -v github.com/maxence-charriere/app/cmd/goapp

# Package sources only:
go get -u -v github.com/maxence-charriere/app/pkg/app

Getting started

cd $GOPATH/src          # go to your gopath sources (optional)
mkdir demo && cd demo   # create and go to your go package
goapp init -v           # init project layout
goapp run -v -b chrome  # run the app and launch the main page on chrome

How it works

Project layout
demo
└── cmd
    ├── demo-server
    │   ├── main.go
    │   └── web
    │       ├── style sheets...
    │       ├── images...
    │       └── etc...
    └── demo-wasm
        └── main.go
  • The cmd directory contains the project main applications.
  • The demo-wasm directory contains the app that is compiled in wasm and that will run in the browser.
  • The demo-server directory contains the server that serves the wasm app and its resources.
  • The web directory contrains the app resources like style sheets (css), images and other static resources.

Project layout can be initialized by running this command in the repository root.

goapp init -v
App

The app is the Go code compiled in web assembly and executed in the browser.

// cmd/demo-wasm/main.go

package main

import (
    "log"

    "github.com/maxence-charriere/app/pkg/app"
    "github.com/maxence-charriere/app/pkg/log"
)

type Hello struct {
    Name string
}

func (h *Hello) Render() string {
    return `
<div class="Hello">
    <h1>
        Hello
        {{if .Name}}
            {{.Name}}
        {{else}}
            world
        {{end}}!
    </h1>
    <input value="{{.Name}}" placeholder="What is your name?" onchange="Name" autofocus>
</div>
    `
}

func main() {
    app.Import(&Hello{})

    app.DefaultPath = "/hello"
    app.Run()
}
Server

The server serves the web assembly Go program and the other resources.

// cmd/demo-server/main.go

package main

import (
    "log"
    "net/http"
    "github.com/maxence-charriere/app"
)

func main() {
    http.Handle("/", &app.Handler{})

    if err := http.ListenAndServe(":3000", nil); err != nil {
        log.Fatal(err)
    }
}

Build

The whole project can be built with the goapp CLI tool. goapp builds the server, the wasm app, imports the required javascript support file and puts the pieces together to provide a ready to use project.

# Get the goapp CLI tool:
go get -u github.com/maxence-charriere/app/cmd/goapp

# Builds a server ready to serve the wasm app and its resources:
goapp build -v

# Launches the server and app in the default browser:
goapp run -v -b default

Once built, the directory tree should look like:

demo
└── cmd
    ├── demo-server
    │   ├── demo-server (server)
    │   ├── main.go
    │   └── web
    │       ├── goapp.wasm (app)
    │       ├── wasm_exec.js
    │       ├── images...
    │       └── etc...
    └── demo-wasm
        └── main.go

See a full example.

Live demo

Support

Platform Chrome Edge Firefox Safari
Desktop ✔*
Mobile

Issues:

  • Non Chromiun based Edge does not support TextEncoder which is used by the javascript support file provided by Go.
Expand ▾ Collapse ▴

Directories

Path Synopsis
cmd
demo
pkg
app
log
internal