Home

Contributing

Contributing to Cobalt is really easy. Find an issue that you'd like to try and fix, and then fork this repository to your own GitHub account.

Requirements

Ensure that the following software has been installed on your server:

• Node.js ^0.12.7 (nvm recommended)
• MongoDB ^3.0.2

Installation

git clone https://github.com/<USER>/cobalt.git && cd cobalt
npm install

Starting

You'll need to set the following environment variables (refer to this guide if you're unsure how to set new environment variables).

• COBALT_PORT : The port at which you would like to deploy Cobalt (ex. 4242)
• COBALT_MONGO_URI : the MongoDB connection URI used to connect to your MongoDB database server (ex. mongodb://localhost/cobalt)

To start your local instance:

npm start

Developing

You can now make changes to the source code. To test your changes:

npm test

Submitting

Once you have finished your feature/fix, push it to your forked repository and submit a pull request detailing your changes.