qmk_configurator
1.0.0
Конфигуратор QMK - это онлайн -инструмент, используемый для легко создания файлов прошивки для клавиатур, поддерживаемых в QMK_FIRMWARE. Инструмент расположен на https://config.qmk.fm.
Конфигуратор QMK обеспечивает простое создание и сохранение KeyMap через файлы .json 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
См. Ссылка на конфигурацию.
Если у вас еще нет веб -сервера, и вы уже не имеете внимания, вы можете использовать Docker. По умолчанию он раскрывает автономную среду.
docker run -p 8080:80 qmkfm/qmk_configurator:latest
Вы можете указать другой бэкэнд URL, установив VUE_APP_API_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
Пожалуйста, обратитесь к этому документу
