qmk_configurator

量子机械键盘配置器

QMK配置器是一种在线工具，用于轻松创建QMK_FIRMWARE支持的键盘固件文件。该工具位于https://config.qmk.fm上。

QMK配置器允许通过.json Keymap文件创建简单的KeyMap创建和保存，并生成适当的固件文件，以闪烁到选定的键盘上。

这个项目正在进行中。要开始贡献，请参考以下内容：

• 问题

发展

我们建议您安装和使用NVM来管理节点版本。项目目录的根部有一个.NVMRC文件，该文件已通过我们的依赖项进行了测试。

选择节点版本

nvm use

项目设置

 yarn install

编译和开发热填充

 yarn run dev

编译和生产

 yarn run build

运行您的测试

 yarn run test

绒毛和修复文件

 yarn run lint

运行您的端到端测试

分开启动服务器

 yarn run test:cypress

运行您的端到端测试，例如CI

分开启动服务器

 yarn run test:cypress:ci

运行单位测试

 yarn run test:unit

自定义配置

请参阅配置参考。

Docker

如果您还没有Web服务器，并且还没有牢记一个网络服务器，则可以使用Docker。默认情况下，它旋转一个独立的环境。

 docker run -p 8080:80 qmkfm/qmk_configurator:latest

您可以通过设置VUE_APP_API_URL来指定不同的后端URL：

 docker run -e VITE_API_URL=http://localhost:8080 -p 8080:80 qmkfm/qmk_configurator:latest

如果您想在本地开发，则可以使用卷将本地文件系统与容器联系起来：

 docker run --mount type=volume,source=.,target=/qmk_configurator -p 8080:80 qmkfm/qmk_configurator:latest

构建Docker图像

在大多数情况下，您无需这样做，您可以使用上述音量安装座，将预先构建的图像与本地树一起使用。

如果由于某种原因您需要自己构建，则可以使用此命令：

 docker build -t qmk_configurator .

这个过程将需要一段时间。您可能想去喝点茶或其他东西。完成后，您可以使用此命令运行它：

 docker run -p 8080:80 qmk_configurator

国际化指南

请参阅此文件