Repository files navigation

Agent is the configuration application of theUltimate Hacking Keyboard.

Please do not build Agent from source unless you want to develop it. Using an existing release is far easier for everyone involved:

• If you already own a UHK thendownload the latest desktop build of Agent from the releases page. On Linux, download the AppImage, make it executable, and run it. If you don't own a UHK then you won't get past the opening screen!
• If you don't own a UHK yet thentry out the web build of Agent in your browser. This is meant to be used for demonstration purposes.

You'll need Node.js 12. Use your OS package manager to install it.Check the NodeJS site for more info. Mac OS users can simplybrew install node to get both. Should you need multiple Node.js versions on the same computer, use Node Version Manager forMac/Linux or forWindows

You'll also needlibusb.On debian-based linux distros,apt-get install libusb-dev libudev-dev g++ is sufficient.On Mac OS, usebrew install libusb libusb-compat.For everyone else, use the appropriate package manager for your OS.

git clone git@github.com:UltimateHackingKeyboard/agent.gitcd agentnpm installnpm run buildnpm run electron

At this point, Agent should be running on your machine.

• The frontend code is located inpackages/uhk-web/
• Run the project locally withnpm run server:web
• View the app athttp://localhost:8080
• The app will automatically reload when you make changes

Wanna contribute? Please let us show youhow.