Skip to content

Commit

Permalink
chore: clean up lint warnings in README
Browse files Browse the repository at this point in the history
 - format for 80 cols
 - add block formatting markers
  • Loading branch information
yanfali committed Jan 4, 2025
1 parent 717df34 commit 481fb62
Showing 1 changed file with 51 additions and 18 deletions.
69 changes: 51 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,94 +6,127 @@
[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_configurator.svg)](https://github.com/qmk/qmk_configurator/pulse/monthly)
[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_configurator.svg?style=social&label=Fork)](https://github.com/qmk/qmk_configurator/)

The QMK Configurator is an online tool used for easily creating firmware files for keyboards supported in [qmk_firmware](https://github.com/qmk/qmk_firmware). The tool is located on https://config.qmk.fm.
The QMK Configurator is an online tool used for easily creating firmware files
for keyboards supported in [qmk_firmware](https://github.com/qmk/qmk_firmware).
The tool is located on <https://config.qmk.fm>.

The QMK Configurator allows simple keymap creation and saving via .json keymap files, and generates appropriate firmware files for flashing onto selected keyboards.
The QMK Configurator allows simple keymap creation and saving via .json keymap
files, and generates appropriate firmware files for flashing onto selected
keyboards.

This project is very much a work in progress. To begin contributing, please refer to the following:
This project is very much a work in progress. To begin contributing, please
refer to the following:

* [Issues](https://github.com/qmk/qmk_configurator/issues)
- [Issues](https://github.com/qmk/qmk_configurator/issues)

## Development

We recommend you install and use [NVM](https://github.com/creationix/nvm) to manage node versions. There is a .nvmrc file in the root of the project directory that has been tested with our dependencies.
We recommend you install and use [NVM](https://github.com/creationix/nvm) to
manage node versions. There is a .nvmrc file in the root of the project
directory that has been tested with our dependencies.

### Select node version

```shell
nvm use
```

### Project setup
```

```shell
yarn install
```

### Compiles and hot-reloads for development
```

```shell
yarn run dev
```

### Compiles and minifies for production
```

```shell
yarn run build
```

### Run your tests
```

```shell
yarn run test
```

### Lints and fixes files
```

```shell
yarn run lint
```

### Run your end-to-end tests

Start the server separatly
```

```shell
yarn run test:cypress
```

### Run your end-to-end tests like CI

Start the server separatly
```

```shell
yarn run test:cypress:ci
```

### Run your unit tests
```

```shell
yarn run test:unit
```

### Customize configuration

See [Configuration Reference](https://vitejs.dev/config/).

## Docker

If you don't have a webserver already and don't already have one in mind you can use docker. By default it spins up a self-contained environment.
If you don't have a webserver already and don't already have one in mind you
can use docker. By default it spins up a self-contained environment.

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

You can specify a different backend URL by setting `VUE_APP_API_URL`:

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

If you'd like to develop locally you can use a volume to tie your local filesystem to the container:
If you'd like to develop locally you can use a volume to tie your local
filesystem to the container:

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

### Building The Docker Image

Most of the time you don't need to do this, you can use volume mounts as described above to use the pre-built image with your local tree.
Most of the time you don't need to do this, you can use volume mounts as
described above to use the pre-built image with your local tree.

If for some reason you do need to build it yourself, you can use this command:

```shell
docker build -t qmk_configurator .
```

This process will take a while. You may want to go make some tea or something. When it finishes you can run it with this command:
This process will take a while. You may want to go make some tea or something.
When it finishes you can run it with this command:

```shell
docker run -p 8080:80 qmk_configurator

```

## Internationalization Guide

Please refer to [this document](internationalization_guide.md)

0 comments on commit 481fb62

Please sign in to comment.