Files
agent/README.md
László Monda 69204ab71c Update README.md
2016-08-30 18:22:33 +02:00

26 lines
861 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.
```
git clone git@github.com:UltimateHackingKeyboard/agent.git
cd agent
npm install
npm run build sass
npm run dev
```
At this point, webpack dev server should expose Agent at `localhost:8080`
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more info about contributing.