FRPCheatSheat项目启动与配置教程

1. 项目目录结构及介绍

FRPCheatSheat项目的目录结构如下：

FRPCheatSheat/
├── cheat_sheet.json
├── frp.json
├── frp.sh
├── README.md
├── template/
│   ├── css/
│   │   └── style.css
│   ├── html/
│   │   └── index.html
│   └── js/
│       └── script.js
└── utils/
    └── generate.py

• cheat_sheet.json：存放FRP相关命令和配置的JSON数据。
• frp.json：项目的配置文件，用于定义生成cheat sheet的参数和规则。
• frp.sh：项目的启动脚本，用于生成cheat sheet。
• README.md：项目说明文件。
• template/：存放项目模板文件，包括CSS样式、HTML结构和JavaScript脚本。
  • css/style.css：样式表文件，用于定义cheat sheet的视觉效果。
  • html/index.html：HTML模板文件，用于生成cheat sheet的网页结构。
  • js/script.js：JavaScript脚本文件，用于增强cheat sheet的交互性。
• utils/：存放项目工具脚本。
  • generate.py：Python脚本，用于从cheat_sheet.json生成最终的cheat sheet。

2. 项目的启动文件介绍

项目的启动文件是frp.sh，其内容如下：

#!/bin/bash

# 定义配置文件路径
CONFIG_FILE="frp.json"
# 定义模板目录
TEMPLATE_DIR="template"
# 定义输出目录
OUTPUT_DIR="output"

# 检查配置文件是否存在
if [ ! -f "$CONFIG_FILE" ]; then
  echo "配置文件不存在: $CONFIG_FILE"
  exit 1
fi

# 检查模板目录是否存在
if [ ! -d "$TEMPLATE_DIR" ]; then
  echo "模板目录不存在: $TEMPLATE_DIR"
  exit 1
fi

# 生成cheat sheet
python utils/generate.py $CONFIG_FILE $TEMPLATE_DIR $OUTPUT_DIR

# 输出结果
echo "cheat sheet已生成在 $OUTPUT_DIR 目录下"

运行frp.sh脚本会使用generate.py脚本来读取frp.json中的配置，结合template/目录下的模板文件，生成cheat sheet。

3. 项目的配置文件介绍

项目的配置文件是frp.json，其内容如下：

{
  "title": "FRP Cheat Sheet",
  "description": "一份FRP配置和使用命令的速查表",
  "commands": [
    {
      "name": "frp server",
      "description": "启动FRP服务端",
      "parameters": ["--config", "配置文件路径"]
    },
    {
      "name": "frp client",
      "description": "启动FRP客户端",
      "parameters": ["--config", "配置文件路径"]
    }
    // 更多命令和配置
  ]
}

frp.json文件定义了cheat sheet的标题、描述以及需要展示的命令列表。每个命令包含名称、描述和参数。这些信息将被generate.py脚本读取，并用于生成最终的cheat sheet。