https://github.com/ruiqimao/qmkbuilder

Online GUI for QMK Firmware
https://github.com/ruiqimao/qmkbuilder

builder firmware keyboard qmk

Last synced: about 1 month ago
JSON representation

Online GUI for QMK Firmware

• Host: GitHub
• URL: https://github.com/ruiqimao/qmkbuilder
• Owner: ruiqimao
• License: gpl-3.0
• Created: 2016-12-12T17:40:38.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-09-05T00:07:19.000Z (over 1 year ago)
• Last Synced: 2024-08-02T03:07:57.439Z (4 months ago)
• Topics: builder, firmware, keyboard, qmk
• Language: C
• Homepage: http://kbfirmware.com
• Size: 5.09 MB
• Stars: 380
• Watchers: 15
• Forks: 122
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-repositories - ruiqimao/qmkbuilder - Online GUI for QMK Firmware (C)

README

        
# Keyboard Firmware Builder

## Life Support

On 13 March 2021, kbfirmware.com was shut down due to a lack of users, but has been brought back online after additional consideration.

However, it should be considered end of life, as there will be no additional development and **may stop working at any time**.

### Docker Image

The latest image of kbfirmware.com is available as a Docker image, available at https://hub.docker.com/repository/docker/ruiqimao/kbfirmware.

By default, this image will use port 80. To use any other port, expose and set the `PORT` environment variable accordingly.

## Setup

To set up the project for development, run `npm install` in the root of the project to install dependencies.

Create a `local.json` file in `src/const`, in the format:

    {

		"API": "URL to server /build route",

		"PRESETS": "URL to static/presets folder"

	}

## Compiling

To compile, run `npm run build`.

## Deploying

To deploy a production version of the application, run `npm run deploy`.

## License

Keyboard Firmware Builder is under the GNU GPL v3 license. The license information for QMK Firmware can be found at https://qmk.fm/license/.