install.md

Install

From NPM

NPM hosts the stable release. It will be the least likely to have bugs.

Dependencies:

• node v5.3.x (you might like to use nvm)
• npm v3.5.x (Instructions to update NPM when using NVM)

Install:

npm install ssb-patchwork -g

Run:

patchwork

Then open localhost:7777.

From Git

GitHub hosts the development version. It will contain updates not yet published on NPM.

Dependencies:

• node v5.3.x (you might like to use nvm)
• npm v3.5.x (Instructions to update NPM when using NVM)

Install:

git clone https://github.com/ssbc/patchwork.git
cd patchwork
npm install

Run:

From directory you cloned patchwork to:

npm start

Then open localhost:7777.

Update:

From directory you cloned patchwork to:

git pull origin master
npm install

Updating NPM

Some people experience installation issues when using the npm version packaged with node 5.3.0. We have found upgrading to npm 3.5.x solves these issues.

If you are using nvm, you can update npm with the following steps:

cd ~/.nvm/versions/node/v5.3.0/lib
npm install npm