qmk_configurator

Configurateur de clavier mécanique quantique

Le configurateur QMK est un outil en ligne utilisé pour créer facilement des fichiers de firmware pour les claviers pris en charge dans QMK_Firmware. L'outil est situé sur https://config.qmk.fm.

Le configurateur QMK permet la création de keymap simples et l'enregistrement via des fichiers .json keymap et génère des fichiers de firmware appropriés pour le clignotement sur les claviers sélectionnés.

Ce projet est vraiment un travail en cours. Pour commencer à contribuer, veuillez vous référer à ce qui suit:

• Problèmes

Développement

Nous vous recommandons d'installer et d'utiliser NVM pour gérer les versions de nœuds. Il y a un fichier .nvmrc dans la racine du répertoire du projet qui a été testé avec nos dépendances.

Sélectionner la version nœud

nvm use

Configuration du projet

 yarn install

Compiles et recharges à chaud pour le développement

 yarn run dev

Compiles et minifie pour la production

 yarn run build

Exécutez vos tests

 yarn run test

Lints et corrige les fichiers

 yarn run lint

Exécutez vos tests de bout en bout

Démarrez le serveur séparément

 yarn run test:cypress

Exécutez vos tests de bout en bout comme CI

Démarrez le serveur séparément

 yarn run test:cypress:ci

Exécutez vos tests unitaires

 yarn run test:unit

Personnaliser la configuration

Voir référence de configuration.

Docker

Si vous n'avez pas déjà de serveur Web et que vous n'en avez pas déjà en tête, vous pouvez utiliser Docker. Par défaut, il fait tourner un environnement autonome.

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

Vous pouvez spécifier une URL backend différente en définissant VUE_APP_API_URL :

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

Si vous souhaitez vous développer localement, vous pouvez utiliser un volume pour lier votre système de fichiers local au conteneur:

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

Construire l'image Docker

La plupart du temps, vous n'avez pas besoin de le faire, vous pouvez utiliser des supports de volume comme décrit ci-dessus pour utiliser l'image prédéfinie avec votre arbre local.

Si pour une raison quelconque, vous devez le construire vous-même, vous pouvez utiliser cette commande:

 docker build -t qmk_configurator .

Ce processus prendra un certain temps. Vous voudrez peut-être aller faire du thé ou quelque chose comme ça. Quand il se termine, vous pouvez l'exécuter avec cette commande:

 docker run -p 8080:80 qmk_configurator

Guide d'internationalisation

Veuillez vous référer à ce document