QMK Builder 项目教程

QMK Builder 项目教程

qmkbuilderOnline GUI for QMK Firmware项目地址:https://gitcode.com/gh_mirrors/qm/qmkbuilder

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

QMK Builder 是一个用于 QMK 固件的在线图形用户界面（GUI）。项目的目录结构如下：

qmkbuilder/
├── src/
│   ├── const/
│   ├── ...
├── package.json
├── README.md
├── ...

• src/：包含项目的主要源代码。
  • const/：存放常量配置文件。
• package.json：项目的依赖和脚本配置文件。
• README.md：项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中的脚本配置。以下是一些关键的启动脚本：

{
  "scripts": {
    "start": "node index.js",
    "build": "npm run build",
    "deploy": "npm run deploy"
  }
}

• start：启动开发服务器。
• build：编译项目。
• deploy：部署生产版本的应用程序。

3. 项目的配置文件介绍

项目的配置文件主要位于 src/const/ 目录下。你需要创建一个 local.json 文件，格式如下：

[
  {
    "API": "URL to server /build route",
    "PRESETS": "URL to static/presets folder"
  }
]

• API：指向服务器构建路由的 URL。
• PRESETS：指向静态预设文件夹的 URL。

这些配置文件用于设置项目的 API 和预设路径。

---

以上是 QMK Builder 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

qmkbuilderOnline GUI for QMK Firmware项目地址:https://gitcode.com/gh_mirrors/qm/qmkbuilder