qmk_configurator
1.0.0
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
分開啟動服務器
yarn run test:cypress:ci
yarn run test:unit
請參閱配置參考。
如果您還沒有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 build -t qmk_configurator .
這個過程將需要一段時間。您可能想去喝點茶或其他東西。完成後,您可以使用此命令運行它:
docker run -p 8080:80 qmk_configurator
請參閱此文件