https://github.com/keebio/kb-plategen

https://github.com/keebio/kb-plategen

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/keebio/kb-plategen
• Owner: keebio
• Created: 2020-07-15T20:22:25.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-14T03:46:08.000Z (over 1 year ago)
• Last Synced: 2024-01-22T03:51:32.117Z (5 months ago)
• Language: TypeScript
• Size: 378 KB
• Stars: 35
• Watchers: 7
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Lists

• awesome-keebio - Keyboard Plate Generator

README

        
# Keyboard Plate Generator by Keebio

This is a keyboard switch plate generator that takes in output from [Keyboard Layout Editor](http://www.keyboard-layout-editor.com/) and generates a switch plate based on the parameters you specify. The generation of the plate is all done client-side and leverages the [Maker.js](https://github.com/Microsoft/maker.js) library to draw out all the paths.

## Development & Contributing

### Running the Generator Locally

In the project directory, you can run the following command to run the app on your machine:

`yarn start`

Runs the app in the development mode.


Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.


You will also see any lint errors in the console.

### Project Tracking Board

If you'd like to help out with this project, check the Trello board that's been setup to see what kind of help is currently needed: [Project status board](https://trello.com/b/Kfx0hbyo/plate-generator)

Any bit of help is appreciated!