qmk_configurator

Configurador de teclado mecânico quântico

O Configurator QMK é uma ferramenta on -line usada para criar arquivos de firmware facilmente para teclados suportados em QMK_Firmware. A ferramenta está localizada em https://config.qmk.fm.

O configurador QMK permite a criação simples de keymap e a economia de arquivos .json keymap e gera arquivos de firmware apropriados para piscar em teclados selecionados.

Este projeto é um trabalho em andamento. Para começar a contribuir, consulte o seguinte:

• Problemas

Desenvolvimento

Recomendamos que você instale e use o NVM para gerenciar versões do nó. Existe um arquivo .nvmrc na raiz do diretório do projeto que foi testado com nossas dependências.

Selecione a versão do nó

nvm use

Configuração do projeto

 yarn install

Compilam e reloades quentes para desenvolvimento

 yarn run dev

Compila e minifica para a produção

 yarn run build

Execute seus testes

 yarn run test

Fios e correções arquivos

 yarn run lint

Execute seus testes de ponta a ponta

Inicie o servidor separadamente

 yarn run test:cypress

Execute seus testes de ponta a ponta como CI

Inicie o servidor separadamente

 yarn run test:cypress:ci

Execute seus testes de unidade

 yarn run test:unit

Personalize a configuração

Consulte Referência de configuração.

Docker

Se você ainda não possui um servidor da web e ainda não tem um em mente, pode usar o Docker. Por padrão, ele gira um ambiente independente.

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

Você pode especificar um URL de back -end diferente definindo VUE_APP_API_URL :

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

Se você deseja desenvolver localmente, pode usar um volume para amarrar o sistema de arquivos local ao contêiner:

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

Construindo a imagem do Docker

Na maioria das vezes, você não precisa fazer isso, você pode usar montagens de volume, conforme descrito acima, para usar a imagem pré-construída com sua árvore local.

Se, por algum motivo, você precisar construí -lo sozinho, poderá usar este comando:

 docker build -t qmk_configurator .

Esse processo levará um pouco. Você pode querer fazer um chá ou algo assim. Quando terminar, você pode executá -lo com este comando:

 docker run -p 8080:80 qmk_configurator

Guia de internacionalização

Consulte este documento