2023-02-17 17:37:58 +08:00
< p align = "center" >
< img src = "https://assets.yanghy.cn/energy-doc/energy-icon.png" >
< / p >
2023-02-14 20:33:57 +08:00
# Energy is the framework for Go to build desktop applications based on CEF
[中文 ](README.zh_CN.md ) |
2022-12-03 15:05:07 +08:00
English
2022-10-04 16:21:00 +08:00
2022-10-06 16:39:52 +08:00
---
2023-02-14 20:33:57 +08:00
[](https://github.com/energye/energy)
[](https://github.com/energye/energy/releases)
[](http://www.apache.org/licenses/LICENSE-2.0)
---
### [Project Introduction](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/6350f94ca749ba0318943f25)
Energy is a framework developed by Golang based on CEF(Chromium Embedded Framework), embedded with [CEF ](https://bitbucket.org/chromiumembedded/cef ) binary
> [energy](https://github.com/energye/energy) is a framework developed by Golang based on CEF(Chromium Embedded Framework), embedded with [CEF](https://bitbucket.org/chromiumembedded/cef) binary
2022-10-06 16:39:52 +08:00
>
2023-02-14 20:33:57 +08:00
> Use Go and Web technology (HTML+CSS+JavaScript) to build cross-platform desktop applications that support Windows, Linux and MacOS
2022-10-06 16:39:52 +08:00
>
2023-02-17 16:03:28 +08:00
> Knowledge of the front-end technology stack and some knowledge of the Go language is required
2023-02-17 14:34:25 +08:00
### Characteristic
2023-02-17 14:38:44 +08:00
> - 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
2023-02-17 14:34:25 +08:00
> - cross-platform: A set of code can be packaged into Windows, domestic UOS, Deepin, Kylin, MacOS, Linux
> - Language responsibilities
2023-02-17 16:03:28 +08:00
>> - 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., which can be developed as a pure backend
>> - Web: HTML + CSS + JavaScript responsible for the function of the client interface, make any interface you want, can be used as a pure front-end development
2023-02-17 14:34:25 +08:00
> - 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
2023-02-14 20:33:57 +08:00
### Go interacts with the Web
> The Go and Web technologies are based on IPC communication. Data and event triggering can be exchanged between Go and Web without using the http interface, which is as simple as calling the functions of the language itself
>
> Define JS binding type variables in Go and provide them to JS on the Web side to realize data synchronization of Go variables or structural objects
>
> Listen for events in JS and trigger JS events in Go to achieve Go calling JS functions and passing parameter
>
> Listen for events in Go and trigger Go events in JS to achieve JS calling Go functions and passing parameters
2022-10-06 16:39:52 +08:00
>
2022-10-04 16:21:00 +08:00
2023-02-14 20:33:57 +08:00
### Built-in dependency&integration
2022-10-06 16:39:52 +08:00
2023-02-14 20:33:57 +08:00
- [](https://github.com/energye/golcl)
- [](https://github.com/energye/liblcl)
- [](https://github.com/salvadordf/CEF4Delphi)
- [-green)](https://bitbucket.org/chromiumembedded/cef)
### [Development environment](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/63511b14a749ba0318943f3a)
> Install automatically using the energy command line tool
#### Basic needs
> - golang >= 1.18
2022-11-28 22:44:13 +08:00
>
2023-02-14 20:33:57 +08:00
> - energy development environment
>
> Use the energy command line tool to automatically install the development environment
>
> Get [energy](https://github.com/energye/energy)
> project, or use the precompiled command line tool directly [Download address](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/63511b14a749ba0318943f3a)
2022-11-28 22:44:13 +08:00
> 1. go get github.com/energye/energy
>
2023-02-14 20:33:57 +08:00
> Enter the [energy](https://github.com/energye/energy) command line directory
2022-11-28 22:44:13 +08:00
> 2. cd energy/cmd/energy
>
2023-02-14 20:33:57 +08:00
> Install command line tools
2022-11-28 22:44:13 +08:00
> 3. go install
>
2023-02-14 20:33:57 +08:00
> Execute the installation command
2022-11-28 22:44:13 +08:00
> 4. energy install .
2022-10-18 15:15:29 +08:00
2023-02-14 20:33:57 +08:00
### Getting Started Guide - [Transfer gate](https://energy.yanghy.cn)
* [course ](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/6350f94ca749ba0318943f25 )
* [example ](https://energy.yanghy.cn/#/example/6342d986401bfe4d0cdf6067/634d3bd5a749ba0318943eb6 )
2022-12-03 15:05:07 +08:00
* [document ](https://energy.yanghy.cn/#/document/6342d9a4401bfe4d0cdf6069/0 )
2022-10-06 16:39:52 +08:00
2023-02-14 20:33:57 +08:00
### Quick Get Start
> Use [energy](https://github.com/energye/energy) Command line tool automatic installation environment dependency `energy install .`
2022-10-06 16:39:52 +08:00
>
2023-02-14 20:33:57 +08:00
> Take example/simple as an example
2022-10-06 16:39:52 +08:00
>
2023-02-14 20:33:57 +08:00
> Update latest release dependency
2022-10-06 16:39:52 +08:00
>
2023-02-14 20:33:57 +08:00
> `go mod tidy`
2022-10-06 16:39:52 +08:00
>
2023-02-14 20:33:57 +08:00
> Run `simple` in the IDE or `go run simple.go`
### example/simple Code
2022-10-06 16:39:52 +08:00
```go
package main
import (
"github.com/energye/energy/cef"
)
func main() {
2023-02-14 20:33:57 +08:00
//Global initialization must be called by every application
2023-02-02 19:37:16 +08:00
cef.GlobalInit(nil, nil)
2023-02-14 20:33:57 +08:00
//Create application
2022-11-20 12:31:41 +08:00
cefApp := cef.NewApplication(nil)
2023-02-14 20:33:57 +08:00
//Set URL
cef.BrowserWindow.Config.Url = "https://energy.yanghy.cn"
//Run App
2022-10-06 16:39:52 +08:00
cef.Run(cefApp)
}
```
2023-02-14 20:33:57 +08:00
---
### Pack Project [reference](https://energy.yanghy.cn/#/course/6342d92c401bfe4d0cdf6065/636e397ba749ba01d04ff595)
1. Compile: Go program compilation `go build xxx. go` If you use resource built-in (HTML, CSS, JavaScript, Image, etc.), the resource will be compiled into the execution file
2. Copy: copy the execution file to the CEF directory of the ENERGY environment
3. Packaging: use the installation package tool to make it as an installation package, Or refer to the production of installation package for each system platform
4. Finally: the compiled program or installation package and CEF directory no longer need to configure the environment, and can be run directly in the CEF root directory
2023-02-14 20:57:32 +08:00
#### Go Compile Command
2023-02-14 20:33:57 +08:00
1. Compress and hide the cmd window `go build -ldflags "-H windowsgui -s -w"` , Note: Windows needs to hide the CMD window
2. Compress `go build -ldflags "-s -w"`
2. Uncompressed `go build`
---
### System support
| | 32 Bit | 64 Bit | Test System Version |
|-----------|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|------------------------------------|
| Windows |  |  | Windows 7、Windows 10 |
| MacOSX |  |  | MacOSX 10.15 |
| Linux |  |  | Deepin20.8、Ubuntu18.04、LinuxMint21 |
| Linux ARM |  |  | Kylin-V10-SP1-2107 |
---
### QQ Group
[](https://jq.qq.com/?_wv=1027& k=YgFjCGJX)
2023-02-14 20:45:00 +08:00
< img src = "https://assets.yanghy.cn/energy-doc/qq-group.jpg" width = "300" >
2023-02-14 21:04:18 +08:00
2023-02-14 20:33:57 +08:00
---
### Project screenshot
##### Windows-10
2023-02-17 13:02:16 +08:00
< img src = "https://assets.yanghy.cn/energy-doc/frameless-windows-10.png" >
2023-02-14 20:33:57 +08:00
2023-02-17 12:59:36 +08:00
##### Windows-7 32 & 64
2023-02-17 13:02:16 +08:00
< img src = "https://assets.yanghy.cn/energy-doc/frameless-windows-7-64.png" >
< img src = "https://assets.yanghy.cn/energy-doc/frameless-windows-7-32.png" >
2023-02-14 20:33:57 +08:00
2023-02-17 12:59:36 +08:00
##### Linux - Deepin
2023-02-17 13:02:16 +08:00
< img src = "https://assets.yanghy.cn/energy-doc/frameless-deepin-20.8.png" >
< img src = "https://assets.yanghy.cn/energy-doc/frameless-deepin-hide-20.8.png" >
2023-02-14 20:33:57 +08:00
2023-02-17 12:59:36 +08:00
##### Linux - Kylin ARM
2023-02-17 13:02:16 +08:00
< img src = "https://assets.yanghy.cn/energy-doc/frameless-kylin-arm-V10-SP1.png" >
< img src = "https://assets.yanghy.cn/energy-doc/frameless-kylin-arm-hide-V10-SP1.png" >
2023-02-17 12:59:36 +08:00
##### Linux - Ubuntu
2023-02-17 13:02:16 +08:00
< img src = "https://assets.yanghy.cn/energy-doc/frameless-ubuntu-18.04.6.png" >
< img src = "https://assets.yanghy.cn/energy-doc/frameless-ubuntu-hide-18.04.6.png" >
2023-02-14 20:33:57 +08:00
##### MacOSX
2023-02-17 13:02:16 +08:00
< img src = "https://assets.yanghy.cn/energy-doc/frameless-macos.png" >
2023-02-14 20:33:57 +08:00
2022-10-18 17:21:02 +08:00
2022-10-18 18:16:16 +08:00
----
2023-02-14 20:33:57 +08:00
### Public License
[](http://www.apache.org/licenses/LICENSE-2.0)
