Files
agent/README.md
Farkas József 61c20cd678 Improve npm scripts consistency
Closes #255
2017-02-13 23:10:22 +01:00

25 lines
842 B
Markdown

![Agent logo & text](https://raw.githubusercontent.com/UltimateHackingKeyboard/agent-mockup/master/images/agent-logo-with-text.png)
[![Build Status](https://travis-ci.org/UltimateHackingKeyboard/agent.svg?branch=master)](https://travis-ci.org/UltimateHackingKeyboard/agent)
Agent is the configuration application of the [Ultimate Hacking Keyboard](https://ultimatehackingkeyboard.com/).
[Give it a whirl!](http://ultimatehackingkeyboard.github.io/agent/)
## Set up instructions
First up, make sure that node >=4.x.x and npm >=3.x.x are installed on your system. Next up:
```
git clone git@github.com:UltimateHackingKeyboard/agent.git
cd agent
npm install
npm run server:web
```
At this point, webpack dev server should expose Agent at `localhost:8080`
## Contributing
Wanna contribute? Please let us show you [how](CONTRIBUTING.md).