qmk_configurator

Quantum Mechanical Keyboard Configurator

QMK Configuratorは、QMK_Firmwareでサポートされているキーボードのファームウェアファイルを簡単に作成するために使用されるオンラインツールです。このツールはhttps://config.qmk.fmにあります。

QMK Configuratorは、.JSONキーマップファイルを介してシンプルなキーマップの作成と保存を可能にし、選択したキーボードにフラッシュするための適切なファームウェアファイルを生成します。

このプロジェクトは非常に進行中の作業です。貢献を開始するには、以下を参照してください。

• 問題

発達

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

国際化ガイド

このドキュメントを参照してください