LightProxy 使用教程

LightProxy 使用教程

项目地址:https://gitcode.com/gh_mirrors/lig/lightproxy

1. 项目的目录结构及介绍

lightproxy/
├── bin/
├── docs/
├── examples/
├── src/
│   ├── main/
│   └── renderer/
├── test/
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

• bin/: 包含可执行文件。
• docs/: 包含项目文档。
• examples/: 包含示例代码。
• src/: 源代码目录，分为 main 和 renderer 两个主要部分。
  • main/: 主进程代码。
  • renderer/: 渲染进程代码。
• test/: 测试代码。
• .gitignore: Git 忽略文件配置。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

在 src/main/ 目录下，主要的启动文件是 index.ts。这个文件负责启动 Electron 的主进程，并初始化应用的主要功能。

// src/main/index.ts
import { app, BrowserWindow } from 'electron';
import path from 'path';

function createWindow() {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
    },
  });

  mainWindow.loadFile('index.html');
}

app.whenReady().then(() => {
  createWindow();

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow();
  });
});

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit();
});

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "lightproxy",
  "version": "1.0.0",
  "description": "Cross platform Web debugging proxy",
  "main": "src/main/index.js",
  "scripts": {
    "start": "electron .",
    "build": "electron-builder"
  },
  "dependencies": {
    "electron": "^12.0.0"
  },
  "devDependencies": {
    "electron-builder": "^22.10.5"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了编译选项。

{
  "compilerOptions": {
    "target": "ES2017",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

通过以上配置，可以确保项目能够正确编译和运行。

lightproxy lightweight local proxy 项目地址: https://gitcode.com/gh_mirrors/lig/lightproxy