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 ^5.6 (nvm recommended)
• MongoDB ^3.0.2

Setup

Verify that MongoDB is installed and running. Refer to the MongoDB installation guide for more information.

Next, clone your forked repo and install the dependencies:

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

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

• COBALT_MONGO_URI : the MongoDB connection URI used to connect to your MongoDB database server (ex. mongodb://localhost/cobalt). This database will have Cobalt's datasets synced to it automatically when you run Cobalt.
• PORT (optional) : the port Cobalt will listen to for incoming connections. Default: 4242

Starting

To start your local instance:

npm run dev

Developing

You can now make changes to the source code. Cobalt will automatically update as you make changes to files in the src/ directory. 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.