Developing MiddGuard

This guide describes how to develop MiddGuard itself, not a MiddGuard-based investigation.

Install Node.js using n or nvm.

$ node --version
6.2.0

Clone the repository from GitHub.

$ git clone https://github.com/ProfBlack/middguard.git

Install MiddGuard's dependencies. The postinstall hook will install the Bower dependencies.

$ npm install

Run the database migrations.

$ ./bin/middguard migrate --knexfile examples/simple/knexfile.js

Make some changes and start a server with one of the example projects.

$ node examples/simple

Alternatively, install nodemon with npm install -g nodemon and start the server with nodemon examples/simple. nodemon watches for changes and automatically restarts the server.