Skip to content

Easily create beautiful heatmaps for your qmk keyboard

License

Notifications You must be signed in to change notification settings

maslomeister/easyheatmap

Repository files navigation


Logo

Easy heatmap

Easily create beautiful heatmaps for your qmk keyboard
Website · Report Bug · Request Feature

Build and deploy

About The Project

This tool will allow you to create heatmap for you qmk keyboard in a few easy steps, you can also customize the look of your heatmap very easily.

ReactViteRedux

Example of usage

In the first half of the video i'm setting up relation between keyboard layout image and keymap, you'll need to do it only once, after that is done all of the settings are saved to local storage of the browser

preview.mp4

Examples of resulting heatmaps

Example one Example two Example three

Local usage

Prerequisites:

node >= 18.7.0
npm >= 8.15.0
  1. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  2. Install NPM packages
    npm install
  3. Start local server
    npm run dev

Roadmap

  • Add settings page
    • import/export data
    • reset saved config
    • change image or key matrix
    • preview mapping data on image
    • create custom layer names
  • Add drop down for layers selection
  • Add settings page where one could view and change saved settings
  • See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Acknowledgments

(back to top)

About

Easily create beautiful heatmaps for your qmk keyboard

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published