uniocjs/core 项目启动与配置教程

1. 项目目录结构及介绍

uniocjs/core 项目的目录结构如下：

uniocjs/core/
├── .gitignore           # 忽略文件列表
├── .npmrc               # npm 配置文件
├── CHANGELOG.md         # 更新日志
├── CONTRIBUTING.md      # 贡献指南
├── LICENSE              # 开源协议
├── README.md            # 项目说明文件
├── package.json         # 项目配置文件
├── package-lock.json    # 项目依赖锁定文件
├── scripts              # 脚本目录
│   └── start.js         # 启动脚本
├── src                  # 源代码目录
│   ├── index.js         # 项目入口文件
│   └── ...              # 其他源代码文件
└── test                 # 测试目录
    └── ...              # 测试文件

• .gitignore：列出 Git 忽略的文件和目录。
• .npmrc：配置 npm 的相关参数。
• CHANGELOG.md：记录项目的版本更新和改动历史。
• CONTRIBUTING.md：指导如何为项目贡献代码和文档。
• LICENSE：项目的开源协议。
• README.md：介绍项目的相关信息和使用方法。
• package.json：项目的依赖配置和脚本。
• package-lock.json：锁定项目依赖的版本。
• scripts：存放项目的脚本文件。
• src：存放项目的源代码。
• test：存放项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 scripts/start.js，该文件的主要作用是启动项目。

// 引入必要的模块
const { app, BrowserWindow } = require('electron');
const path = require('path');

// 创建浏览器窗口
function createWindow() {
  // 创建一个新的浏览器窗口
  const win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: true
    }
  });

  // 并加载应用的 index.html
  win.loadFile(path.join(__dirname, '../src/index.html'));

  // 打开开发者工具
  win.webContents.openDevTools();
}

// 当 Electron 完成初始化并准备创建浏览器窗口时，调用此方法
app.whenReady().then(createWindow);

// 所有窗口关闭时退出应用
app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit();
  }
});

app.on('activate', () => {
  // 在 macOS 上，当点击 dock 图标并且没有其他窗口打开时，通常会重新创建一个窗口
  if (BrowserWindow.getAllWindows().length === 0) {
    createWindow();
  }
});

3. 项目的配置文件介绍

项目的配置文件为 package.json，该文件定义了项目的元数据、依赖项和脚本。

{
  "name": "uniocjs-core",
  "version": "1.0.0",
  "description": "uniocjs core library",
  "main": "index.js",
  "scripts": {
    "start": "electron ."
  },
  "keywords": [
    "uniocjs",
    "core",
    "javascript"
  ],
  "author": "uniocjs",
  "license": "MIT",
  "dependencies": {
    "electron": "^11.0.0"
  },
  "devDependencies": {}
}

在 scripts 部分，定义了一个 start 脚本，用于启动 Electron 应用。通过运行 npm start 或 yarn start 命令，即可启动项目。