Skip to content

Quickstart: Installation

Brian edited this page Sep 3, 2016 · 17 revisions

Jump to:

Windows Installation

Download and install Node.js

  1. In the browser, go to http://nodejs.org and download the latest version of the Node.js Windows msi installer for your processor type.
  2. Run the downloaded MSI installer file and follow the instructions in the install program.

Download and install MongoDB

  1. In the browser, go to http://www.mongodb.org and download the latest version of the MongoDB Windows msi installer for your processor type.
  2. Run the downloaded MSI installer file and follow the instructions in the install program.

Install git for Windows

  1. In the browser, go to http://git-scm.com/download/win to download the latest version of git for Windows.
  2. Run the downloaded exe installer file and follow the instructions in the install program.

Install the PencilBlue command-line interface tool

  1. Open a command prompt as an administrator (Microsoft how to).
  2. Run npm install -g pencilblue-cli to install the command-line interface through NPM.

Install and Run PencilBlue

  1. Once pencilblue-cli is installed, in the git bash window (Start Menu -> Git -> Git Bash), cd to the directory that you want the PencilBlue directory to install to.
  2. Run pbctrl install [directory] where directory is the name of the folder you want PencilBlue to be installed to. Follow the instructions.
  3. cd to the directory you installed PencilBlue to and run npm start
  4. You should now be able to navigate to your install of PencilBlue through the URL you specified in the install.

Mac Installation

Download and install Node.js

  1. In the browser, go to http://nodejs.org and download the latest version of the Node.js Mac pkg installer.
  2. Run the downloaded pkg installer file and follow the instructions in the install program.

Download and install MongoDB

The easiest way to install MongoDB on Mac is through Homebrew. If you want to install it manually, MongoDB provides instructions here.

  1. If you don't have Homebrew installed, open a terminal window and run ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  2. In the terminal, run brew install mongodb

Install the PencilBlue command-line interface tool

  1. In the terminal, run npm install -g pencilblue-cli to install the command-line interface through NPM.

Install and Run PencilBlue

  1. Once pencilblue-cli is installed, in the terminal, cd to the directory that you want the PencilBlue directory to install to.
  2. Run pbctrl install [directory] where directory is the name of the folder you want PencilBlue to be installed to. Follow the instructions.
  3. cd to the directory you installed PencilBlue to and run npm start
  4. You should now be able to navigate to your install of PencilBlue through the URL you specified in the install.

Linux Installation

Download and Install Node.js

  • Ubuntu/Debian
  1. Ubuntu's package manager has an outdated version of Node.js, so you'll need to add a repository to install
  2. In a terminal, run curl -sL https://deb.nodesource.com/setup | sudo bash -
  3. Then run sudo apt-get install nodejs to install the latest version of Node.js
  • Fedora
  1. In a terminal, run sudo yum install nodejs npm
  • Arch
  1. In a terminal, run pacman -S nodejs

Install git

  1. In the browser, go to https://git-scm.com/downloads to download the latest version of git.
  2. Download the package and install for your flavor of Linux.

Download and Install MongoDB

  • Ubuntu/Debian
  1. In a terminal, run sudo apt-get install mongodb
  • Fedora
  1. In a terminal, run sudo yum install mongodb
  • Arch
  1. In a terminal, run pacman -S mongodb

Install the PencilBlue command-line interface tool

  1. In the terminal, run npm install -g pencilblue-cli to install the command-line interface through NPM.

Install and Run PencilBlue

  1. Once pencilblue-cli is installed, in the terminal, cd to the directory that you want the PencilBlue directory to install to.
  2. Run pbctrl install [directory] where directory is the name of the folder you want PencilBlue to be installed to. Follow the instructions.
  3. cd to the directory you installed PencilBlue to and run npm start
  4. You should now be able to navigate to your install of PencilBlue through the URL you specified in the install.

Clone this wiki locally