qmk_configurator
1.0.0
El configurador QMK es una herramienta en línea utilizada para crear fácilmente archivos de firmware para teclados admitidos en QMK_Firmware. La herramienta se encuentra en https://config.qmk.fm.
El configurador QMK permite la creación simple de keymap y el ahorro a través de los archivos .json keymap, y genera archivos de firmware apropiados para flashear en los teclados seleccionados.
Este proyecto es en gran medida un trabajo en progreso. Para comenzar a contribuir, consulte lo siguiente:
Le recomendamos que instale y use NVM para administrar versiones de nodos. Hay un archivo .NVMRC en la raíz del directorio del proyecto que se ha probado con nuestras dependencias.
nvm use yarn install
yarn run dev
yarn run build
yarn run test
yarn run lint
Inicie el servidor separado
yarn run test:cypress
Inicie el servidor separado
yarn run test:cypress:ci
yarn run test:unit
Ver Referencia de configuración.
Si aún no tiene un servidor web y aún no tiene uno en mente, puede usar Docker. Por defecto, gira un entorno autónomo.
docker run -p 8080:80 qmkfm/qmk_configurator:latest
Puede especificar una URL de backend diferente configurando VUE_APP_API_URL :
docker run -e VITE_API_URL=http://localhost:8080 -p 8080:80 qmkfm/qmk_configurator:latest
Si desea desarrollar localmente, puede usar un volumen para unir su sistema de archivos local al contenedor:
docker run --mount type=volume,source=.,target=/qmk_configurator -p 8080:80 qmkfm/qmk_configurator:latest
La mayoría de las veces que no necesita hacer esto, puede usar soportes de volumen como se describe anteriormente para usar la imagen preconstruida con su árbol local.
Si por alguna razón necesita construirlo usted mismo, puede usar este comando:
docker build -t qmk_configurator .
Este proceso llevará un tiempo. Es posible que desee ir a preparar un té o algo así. Cuando termine, puede ejecutarlo con este comando:
docker run -p 8080:80 qmk_configurator
Consulte este documento
