53 lines
2.8 KiB
Markdown
53 lines
2.8 KiB
Markdown
|
|
|
|
[](https://travis-ci.org/UltimateHackingKeyboard/agent)
|
|
[](https://ci.appveyor.com/project/mondalaci/agent)
|
|
|
|
Agent is the configuration application of the [Ultimate Hacking Keyboard](https://ultimatehackingkeyboard.com/).
|
|
|
|
[Give it a whirl!](http://ultimatehackingkeyboard.github.io/agent/)
|
|
|
|
## Two builds to rule them all
|
|
|
|
It's worth mentioning that Agent has two builds.
|
|
|
|
The **electron build** is the desktop application which is meant to be used if you have an actual UHK at hand. It starts with an opening screen which detects your UHK. You cannot get past this screen without connecting a UHK via USB.
|
|
|
|
The **web build** is meant to be used for demonstration purposes, so people who don't yet own a UHK can get a feel of Agent and its capabilities in their browser. Eventually, WebUSB support will be added to the web build, making it able to communicate with the UHK. Given the sandboxed nature of browsers, the web build will always lack features that the electron build offers, so this won't make the electron build obsolete.
|
|
|
|
The two builds share code as much as possible.
|
|
|
|
## Building the electron application
|
|
|
|
### Step 1: Build Dependencies
|
|
|
|
You'll need Node.js LTS. 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 git@github.com:UltimateHackingKeyboard/agent.git
|
|
cd agent
|
|
npm install # to install Node dependencies
|
|
npm run build:electron # to build the agent
|
|
npm run electron # to run the newly built agent
|
|
```
|
|
|
|
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).
|