Getting Started

At present the easiest way to get started with Control is to clone the repo to a new directory

git clone -o control git://github.com/serby/ctrl.git <NEW PROJECT>

Setting the origin to control means you can still pull updates once you have started working on your project.

Then define and push to the true project origin:

git remote add origin git@github.com:<USERNAME>/<NEW PROJECT>.git
git push -u origin master

Port Number

By default control runs on port 3021, 3022, 3023 in development, testing and production. If you using control as the base for another project you should set the basePort in properties.js to a random port so that you can run multiple instances of control based projects at the same time.

NPM Modules

Before you can start control you will need to install the npm modules with:

npm install

WARNING: Make sure you are using npm >1.1.12. Previous to that .gitignore files were included in modules making it impossible to check-in a modules node_modules directory.

You can either use npm shrinkwrap or checkin your node_modules into git. Currently I would still recommend the later. To add your npm modules into the repo you need to removing the following from the default control .gitignore.

node_modules

You don't want the build/out folders from the node_modules however so add this to the gitignore:

node_modules/**/out
node_modules/**/build

Then commit them:

git add .gitignore
git add node_modules
git commit -m 'Adding node_modules to repo'