qmk_configurator

Konfigurator Keyboard Mekanik Quantum

QMK Configurator adalah alat online yang digunakan untuk membuat file firmware dengan mudah untuk keyboard yang didukung di QMK_Firmware. Alat ini terletak di https://config.qmk.fm.

QMK Configurator memungkinkan pembuatan keymap sederhana dan menyimpan melalui file .json keymap, dan menghasilkan file firmware yang sesuai untuk mem -flash ke keyboard yang dipilih.

Proyek ini sangat sedang berlangsung. Untuk mulai berkontribusi, silakan merujuk ke yang berikut:

• Masalah

Perkembangan

Kami menyarankan Anda menginstal dan menggunakan NVM untuk mengelola versi node. Ada file .nvmrc di root direktori proyek yang telah diuji dengan dependensi kami.

Pilih Versi Node

nvm use

Pengaturan Proyek

 yarn install

Mengkompilasi dan memuat hot-reload untuk pengembangan

 yarn run dev

Mengkompilasi dan mengurangi untuk produksi

 yarn run build

Jalankan tes Anda

 yarn run test

Serat dan memperbaiki file

 yarn run lint

Jalankan tes ujung ke ujung Anda

Mulailah server secara terpisah

 yarn run test:cypress

Jalankan tes ujung ke ujung seperti CI

Mulailah server secara terpisah

 yarn run test:cypress:ci

Jalankan Tes Unit Anda

 yarn run test:unit

Kustomisasi konfigurasi

Lihat Referensi Konfigurasi.

Buruh pelabuhan

Jika Anda belum memiliki server web dan belum memikirkannya, Anda dapat menggunakan Docker. Secara default itu memutar lingkungan mandiri.

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

Anda dapat menentukan URL backend yang berbeda dengan mengatur VUE_APP_API_URL :

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

Jika Anda ingin mengembangkan secara lokal, Anda dapat menggunakan volume untuk mengikat sistem file lokal Anda ke wadah:

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

Membangun gambar Docker

Sebagian besar waktu Anda tidak perlu melakukan ini, Anda dapat menggunakan volume mount seperti dijelaskan di atas untuk menggunakan gambar pra-built dengan pohon lokal Anda.

Jika karena alasan tertentu Anda perlu membangunnya sendiri, Anda dapat menggunakan perintah ini:

 docker build -t qmk_configurator .

Proses ini akan memakan waktu cukup lama. Anda mungkin ingin membuat teh atau semacamnya. Ketika selesai, Anda dapat menjalankannya dengan perintah ini:

 docker run -p 8080:80 qmk_configurator

Panduan Internasionalisasi

Silakan merujuk ke dokumen ini