https://github.com/UltimateHackingKeyboard/agent

Ultimate Hacking Keyboard configurator
https://github.com/UltimateHackingKeyboard/agent

Last synced: 18 days ago
JSON representation

Ultimate Hacking Keyboard configurator

• Host: GitHub
• URL: https://github.com/UltimateHackingKeyboard/agent
• Owner: UltimateHackingKeyboard
• License: other
• Created: 2016-01-12T00:41:16.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T18:43:10.000Z (7 months ago)
• Last Synced: 2024-04-13T22:11:12.389Z (7 months ago)
• Language: TypeScript
• Homepage: https://ultimatehackingkeyboard.github.io/agent/
• Size: 64.2 MB
• Stars: 680
• Watchers: 32
• Forks: 75
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Agent logo & text](https://raw.githubusercontent.com/UltimateHackingKeyboard/agent/master/packages/uhk-web/src/assets/images/agent-logo-with-text.png)

Agent is the configuration application of the [Ultimate Hacking Keyboard](https://ultimatehackingkeyboard.com/).

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 then [download the latest desktop build of Agent](https://github.com/UltimateHackingKeyboard/agent/releases/latest) 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 then [try out the web build of Agent](https://ultimatehackingkeyboard.github.io/agent/) in your browser. This is meant to be used for demonstration purposes.

## Building the electron application

### Step 1: Build Dependencies

You'll need Node.js 16.17.1. Use your OS package manager to install it. [Check the NodeJS site for more info.](https://nodejs.org/en/download/package-manager/ "Installing Node.js via package manager") Mac OS users can simply `brew install node` to get both. Should you need multiple Node.js versions on the same computer, use Node Version Manager for [Mac/Linux](https://github.com/creationix/nvm) or for [Windows](https://github.com/coreybutler/nvm-windows)

You'll also need `libusb`.

On debian-based linux distros, `apt-get install libusb-dev libudev-dev g++` is sufficient.

On Mac OS, use `brew install libusb libusb-compat`.

For everyone else, use the appropriate package manager for your OS.

### Step 2: Build Environment

```

git clone [email protected]:UltimateHackingKeyboard/agent.git

cd agent

npm install

npm run build

npm run electron

```

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

## Developing the web application

- The frontend code is located in `packages/uhk-web/`

- Run the project locally with `npm run server:web`

- View the app at `http://localhost:8080`

- The app will automatically reload when you make changes

## Contributing

Wanna contribute? Please let us show you [how](CONTRIBUTING.md).