# electron-client

**Repository Path**: rmv/electron-client

## Basic Information

- **Project Name**: electron-client
- **Description**: 使用Electron打包Web项目，并提供相应的本地服务。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2020-03-27
- **Last Updated**: 2021-12-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Electron-Client

### 项目介绍
使用Electron打包Web项目作为一个浏览器使用，另外其还提供日志、WebSocket、执行Linux命令的功能。

### 环境需求
* NodeJS
    * Node版本：`8.12.0`
    * NPM版本：`6.4.1`
* Electron
    * 安装方法：`npm install -g electron`
    * 软件版本：`5.0.4`
* Electron-packager
    * 安装方法：`npm install -g electron-packager`

### 项目打包说明
1. 克隆项目：`git clone <url>`
2. 安装依赖：`npm install`
3. 项目打包(生成到`/package`中)：
    * linux: `electron-packager . main --platform=linux --arch=x64 --electronVersion=7.1.2 --out ./package --overwrite --ignore=logs --ignore=.idea --asar`
    * windows: `electron-packager . main --platform=win32 --arch=all --electronVersion=7.1.2 --out ./package --overwrite --ignore=logs --ignore=.idea --asar`

### 客户端更新说明
* 在打包后，项目的所有内容均打包到`/resources/app.asar`和`/resources/electron.asar`
* 如果不需要更新Electron内核，则直接更新这两个文件就可以了

### 运行说明
##### 配置说明
* 项目第一次执行会自动生成`_local`文件夹，其包含了本地运行的环境
    * `web`: 网页目录
    * `logs`: 日志目录
    * `config.json`: 本地配置
* 配置优先级: `命令行 > 本地配置 > 默认配置`

##### 命令行参数说明
参数      | 名称         | 默认值                   | 说明
----------|--------------|--------------------------|---------
--index   | 进入文件     | /_local/web/index.html   | 本地项目文件
--logs    | 日志目录     | /_local/logs             | 本地日志目录
--console | 控制台       | fasle                    | 打开页面控制台
--port    | NODE服务端口 | 3001                     | NODE相关服务端口
--wsport  | Ws服务端口   | 4001                     | WebSocket相关服务端口

##### 配置文件说明
```
{
  "kiosk": {
    "id": "electron"
  },
  "express": {
    "ip": "127.0.0.1",                      # express监听地址
    "port": 3001                            # express监听端口
  },
  "logs": {
    "dir": ""                               # 日志目录
  },
  "websocket": {
    "port": 4001                            # websocket监听端口
  }
}
```

### 项目结构
```
application
    core                    项目脚本
        environment/        环境变量脚本
        build.js            建立客户端本地文件夹环境脚本
        init.js             项目初始化脚本
    electron                Electron相关
        app.js              Electron创建客户端脚本
    modules                 项目模块
        log4js/             log4模块
    server                  项目服务
        amqp/               消息队列相关服务(未启用)
        express/            Node的Web服务
        socket/             WebSocket相关服务
    web/                    默认窗口相关
    config.json             默认配置文件
    index.js                入口文件
```