Penguin

Penguin is a simple application that helps coordinate merges into a Git repository. This project provides the back-end web service.

Getting Started

To run the Penguin web service:

1. Install Node.js
2. Install MongoDB
3. git clone git://github.com/markhobson/penguin.git
4. cd penguin
5. npm install
6. npm start
7. Visit http://localhost:8081/queues

Command Line Options

The following command line options are supported:

-h, --help  Shows this help
-d, --data  Sets the data layer (memory|mongodb)  [default: "mongodb"]
-p, --port  Sets the server port                  [default: 8081]

Running Tests

To run the unit tests:

npm test

Hosted Instance

Penguin is deployed to Heroku:
http://virtualpenguin.herokuapp.com/

Architecture

The server is a Restify application running on Node.js. It provides a RESTful interface to a MongoDB data persistence layer via the MongoDB Node.js driver.

Unit tests use Mocha with Sinon.JS for mocking.