Installation ❘ Getting Started ❘ Contributing ❘ License

🖳 About The Project

Guark is an open-source framework to build cross platform desktop GUI applications.

📢 What Guark stands for?

Go + Quark = Guark

🔮 Guark mission

Simplify cross platform desktop apps development.

🎸 How it works

Demo Video: https://youtu.be/_k_tq9sj-do

Guark backend and logic part handled by native Go code, while the user interfaces built with modern web technologies (Vue.js, React.js, etc...), and with Guark javascript API you can communicate between your Go and UI framework, and calling your exported Go functions and plugin(s) methods.

🙏 Important note

This is a v0 "WIP" prototype of guark, still a lot to do to make it to production v1. your feedback is very appreciated.

💌 Features

• Desktop applications with GO ♥
• One codebase for Linux, macOS, and Windows
• UI Hot Reload
• You can use any front end framework
• Using native system webview (unlike electron we do not embed chrome in the builds)
• Cross Compile (WIP)
• App Hooks
• App Watchers
• App Plugins (You can make your own)
• Simple
• And more..

📜 Installation

Install guark CLI tool:

go get -u github.com/guark/guark/cmd/guark

If you're on Linux ❤ you need to install some requirements:

// fedora
sudo dnf install gtk3-devel webkit2gtk3-devel gcc-c++ pkgconf-pkg-config

// Ubuntu
sudo apt install libgtk-3-dev libwebkit2gtk-4.0-dev build-essential

Getting Started

After installing guark CLI tool, the next step is to create a new guark project based on the template that you like:

Create a new project

guark new --template vue --dest myapp

Start dev server

After creating new project change your working directory to it and run:

Build your app

You can build your app with

Export your first GO function to JS API

Create a new file in lib/funcs directory:

// lib/funcs/foo_bar.go

import (
	"github.com/guark/guark/app"
)

func FooBar(c app.Context) (interface{}, error) {

   c.App.Log.Debug("Foo bar called")

   return "This is a my return value to javasript", nil
}

Then export it to Guark JS API in lib/config.go file:

import "github.com/your_username/your_app/lib/funcs"

// Exposed functions to guark Javascript api.
var Funcs = app.Funcs{
	"foo": funcs.FooBar,
}

Then you can call your function in javascript:

import g from "guark"

g.call("foo")
 .then(res => console.log(res))
 .catch(err => console.error(err))

See Vue template as an example: https://github.com/guark/vue

Cross Compiling Status.

• Work In Progress. ⚠
• Supported. ✔
• [1]: mingw64-gcc Required.

Install mingw64:

// Fedora
sudo dnf install mingw64-gcc

// Ubuntu
sudo apt install binutils-mingw-w64

You can use any cross compiler for example: env CC=.. CXX=.. guark build --target darwin.

Contributing

PRs, issues, and feedback from ninja gophers are very welcomed.

V1 Roadmap:

• Add App Watchers.
• Add More Templates (React.js, Framework7, and more..)
• Add More Tests.
• Test Guark Apps on MacOS and Windows.
• Auto Reload App When Go Code Changes.
• Guark App Installer (Cross Platform).
• Strip Binaries on build

License

Guark is provided under the MIT License.