dao12dao / app

Package to build GUI apps with Go, HTML and CSS.

app

A multi-platform UI framework that uses Go, HTML and CSS.

Table of Contents

• Install
• Supported platforms
• Hello world
• Architecture
• Goapp
• Documentation
• Donate

Install

# Install:
go get -u -v github.com/murlokswarm/app/...

# Update:
goapp update -v

Supported platforms

Platform	Minimum OS	Minimum Go version	Status
MacOS	MacOS 10.11 (El Capitan)	1.11	✔
Web	MacOS 10.11, Windows 10 (April 2018 Update) or Linux	1.11	✔
Windows	Windows 10 (April 2018 Update)	1.11	🔨
Linux			✖

Hello world

Setup

# Go to your repository:
cd YOUR_REPO

# Init the repo:
goapp mac init

Code

// YOUR_REPO/main.go

// Hello compo.
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="Write a name..." onchange="Name" autofocus>
</div>
    `
}

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

    // Use mac driver with Hello compo.
    app.Run(&mac.Driver{
        URL: "/hello",
    })
}

Build and run

# Build and run with debug mode:
goapp mac run -d

View full example.

Architecture

Elem

An elem represents an UI element to be displayed. Some can be customized with HTML content:

• Windows
• Pages
• Context menus
• Menubar
• Status menu
• Dock

Others are simple:

• Notifications
• FilePanel
• SaveFilePanel
• Share

Compo

A compo represents an independent and reusable piece of UI. It exposes an HTML representation of the UI that can be customized by the template syntax defined in the Go standard library. Compos are loaded into elems that support HTML customization.

Driver

A driver represents the app backend. It exposes Go operations to create/modify the UI and calls their platform specific implementations.

Goapp

Goapp is a CLI tool to build and run apps built with the app package.

Depending on the platform, apps must be packaged in order to be deployed and distributed. Packaged applications are usually not managed by a terminal, which can be an issue when we want to monitor the logs or stop their execution with system signals.

Goapp can package apps and allows to run them while keeping logs and managing their lyfecycle within the terminal.

Examples:

goapp -h         # Help.
goapp mac -h     # Help for MasOS commands.
goapp mac run -h # Help for MasOS run command.

goapp mac run    # Run MacOS .app.
goapp mac run -d # Run MacOS .app with debug.

goapp web run    # Run a web server.
goapp web run -b # Run a web server and launch the main page in the default browser.

Documentation

• Godoc
  • mac
  • web
• Wiki
  • Getting started with MacOS
  • Getting started with web
  • How to use CSS
• Examples
  • hello
  • nav
  • menu
  • status menu
  • dock
  • drag and drop
  • actions/events
  • test
• Readme (other languages)
  • Chinese

Donate

If this project helps you build awesome UI, you can help me grow my cryptos :)