VIA Web Application - Your keyboards best friend

VIA is a powerful, open-source web-based interface for configuring your QMK-powered mechanical keyboard. It allows you to customize your keymaps, create macros, and adjust RGB settings (if it has RGB) on the fly, without needing to recompile your keyboard's firmware. This makes keyboard customization easier and more accessible for everyone.

Getting VIA to support your keyboard

Are you a keyboard maker or a developer interested in adding support for your keyboard? We welcome contributions to the VIA project!

1. The source code of the keyboard has to be merged in QMK Firmware Repositories Master branch.
2. Your keymaps/via keymap has to be merged in VIA's QMK Userspace Repository Main branch.
3. Create a definition in JSON format for your keyboard and submit it as a pull request to VIA's Keyboards Repository Master branch.

Please follow our Specification documentation carefully to ensure your pull request is smoothly reviewed and merged.

Local development setup

Start by cloning the-via/keyboards then install dependencies with npm install and finally npm run build. You should see the output folder dist. This should be copied or symlinked to our repo's public/definitions folder.

# Inside the-via/app
public/definitions -> ../../keyboards/dist

Useful commands

npm run dev

Runs the app in the development mode. Open http://localhost:5173 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

npm run build

Builds a static copy of your site to the build/ folder. Your app is ready to be deployed!

npm run test

Launches the application test runner. Run with the --watch flag (npm test -- --watch) to run in interactive watch mode.

---

This project is tested with BrowserStack.

Looking for an offline app?

@cebby2420 has kindly made a desktop app that does so.

You can find it at https://github.com/cebby2420/via-desktop.

NOTE: This project has no official affiliation with VIA, and we cannot provide support for it.

Facing Issues?

If you encounter any issues or bugs while using the VIA web application, please report them by opening an issue in the Issues section. This will help us to track down and resolve problems, and improve the VIA experience for everyone.

Before reporting, please make sure to check if an issue has already been reported. Thank you!