HSU comes complete with an isolated development environment. You aren't required to use it, if you already have what you get with the development environment then you're already good to go. All you need is:
- Vagrant
- Virtualization software, either: VMware Workstation, VMware Fusion or Virtual Box
- Git
Once you've created the virtual machine you'll have an environment complete with:
- Node.js
- NPM
There are files for editors that should keep the file formatting consistent with what already exists in this repository.
Follow these steps to get started with hacking on HSU.
- Star and fork this repository on GitHub.
- Clone your forked repository
git clone https://github.com/smebberson/hsu.git ./hsu. - Start the virtual machine with
vagrant up(this might take 10 minutes or so).
With that, you'll have a virtual machine up and running.
The entire module lives within ./index.js. All tests can be found in test/test.js.
To run tests use npm test. To show test coverage use npm run coverage. All tests are written using mocha and chai. Please write unit tests for new code you create.
Please send a GitHub pull request with a clear list of what you've done (read more about pull requests). Test coverage is at 100% and ideally, your pull requests will keep it as such.