![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. If you don't own a UHK then you won't get past the opening screen!
  * On Linux, download the AppImage, make it executable, and run it with the `--no-sandbox` option. On recent versions of Ubuntu, you may need to install the `libfuse2t64` package.
* 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 20.x. Use your OS package manager to install it. [Check the Node.js 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 macOS, use `brew install libusb libusb-compat`.
For everyone else, use the appropriate package manager for your OS.

### Step 2: Build Environment

```
git clone git@github.com:UltimateHackingKeyboard/agent.git
cd agent
npm run install
npm run build
npm run electron
```

The `npm run install` script wraps `npm ci --ignore-scripts && npm run postinstall`,
allowing us to skip dependency install scripts. Agent currently has no dependencies
that require post-install steps, so this serves as a workaround until npm 12 ships with Node.js.

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

## Install dependencies

npm workspace installs dependencies in hoisted mode, it is not really suitable for us.
If you add or update a dependency of a package then navigate to the directory edit the package.json and run `npm install --ignore-scripts`

## 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).