energy/README.md

Energy is framework for Go to build desktop applications based on CEF

中文 | English

---

Project Introduction

Energy is a framework developed by Golang based on CEF(Chromium Embedded Framework), embedded with CEF binary

energy is a framework developed by Golang based on CEF(Chromium Embedded Framework), embedded with CEF binary

Use Go and Web technology (HTML+CSS+JavaScript) to build cross-platform desktop applications that support Windows, Linux and MacOS

Knowledge of the front-end technology stack and some knowledge of the Go language is required

Characteristic

• Rich CEF API and LCL system native widgets
• development environment is simple and the compilation speed is fast. Only the Go development environment and the CEF binary framework that Energy depends on are needed
• cross-platform: A set of code can be packaged into Windows, domestic UOS, Deepin, Kylin, MacOS, Linux
• Language responsibilities

• Go: Go is responsible for window creation, CEF configuration and function implementation, creation of various UI components, low-level system calls, and functions that JS cannot handle, such as file stream, security encryption, high-performance processing, etc.
• Web: HTML + CSS + JavaScript responsible for the function of the client interface, make any interface you want, Any front-end technology framework can be used

• front-end technology: Support mainstream front-end frameworks, such as Vue, React, Angular or pure HTML+CSS
• event driven: High performance event driven, IPC based communication, Go and Web side is very convenient function call and data interaction
• resource loading: supports local or built-in to executable files, http service support is not required, multiple choices.

Built-in dependency&integration

• 
• 

Development environment

Install automatically using the energy command line tool

Basic needs

• golang >= 1.18

• energy development environment

Use the energy command line tool to automatically install the development environment

Get energy project, or use the precompiled command line tool directly Download address

If using pre compiled command-line tools, the following steps can be skipped

git clone https://github.com/energye/energy.git

Enter the energy command line directory

cd energy/cmd/energy

Install command line tools

go install

Execute the installation command

energy install .

Getting Started Guide - Transfer gate

• Course
• Example
• Document

Quick Get Start

Must: You need to install the Go development environment yourself Golang Install

Use energy-command-line Command line tool automatic installation environment dependency

energy install .

Take example/simple as an example

Update latest release dependency

go mod tidy

Run simple in the IDE or go run simple.go

example/simple Code

package main

import (
	"github.com/energye/energy/v2/cef"
)

func main() {
	//Global initialization must be called by every application
	cef.GlobalInit(nil, nil)
	//Create application
	cefApp := cef.NewApplication()
	//Set URL
	cef.BrowserWindow.Config.Url = "https://www.yanghy.cn"
	//Run App
	cef.Run(cefApp)
}

---

Run app

• Windows、Linux

go run simple.go

• MacOS

go run simple.go energy_env=dev

---

System support

	32 Bit	64 Bit	Test System Version
Windows			Windows 7、Windows 10、Windows 11
MacOSX			MacOSX 10.15
MacOS M1 M2			MacOS M2, Rosetta2 AMD
Linux			Deepin20.8、Ubuntu18.04、LinuxMint21
Linux ARM			Kylin-V10-SP1-2107

---

Thanks Jetbrains

Thank you for ordering a Star for the project

---

QQ Group

---

Project screenshot

Windows-10

Windows-7 32 & 64

Linux - Deepin

Linux - Kylin ARM

Linux - Ubuntu

MacOSX

---

Public License

Contributors