The following steps are required by everyone participating in the workshop.

Setup a Project

As with any Salesforce project, the first step is getting a new DE org.

  1. Go to and register for a new developer edition org.
  2. Create a new project in the IDE of your choice. Note that some features of this workshop will not be available if you do not use the Mavensmate IDE.
  3. Clone the files from GitHub and place them in your project.
  4. Compile the project to update your DE org. Note, you may need to enable Sites before the project will compile. To do so, visit Setup > Sites in your org.

Optional for non-developers

The following steps are optional for non-develops as they will be used for the advanced section at the end of this workshop.

Install npm

We will use the node package manager (called npm) to install all utilities for this workshop.

  1. Install node from
  2. Verify that you didn’t goof the install by running npm -v. You should see an output similar to 1.4.28.

Install grunt

Grunt is a task automation service that automates utilities when you are developing. This can include anything from compiling LESS or SCSS to deploying resource bundles to Salesforce with the Mavensmate CLI.

  1. If your project does not have a project.json file yet, run npm init to create one.
  2. Install grunt as a project dependency by running npm install grunt --save-dev. The --save-dev portion of the command will list grunt in your package.json as a dependency. This means if anyone else works on your project, they can just run npm install to install all required dependencies.

We will be installing some more grunt modules later, but this will be all for now.

Install the Mavensmate CLI

Mavensmate offers a command-line interface that can be installed via npm.

  1. Install the module by running npm install mavensmate -g. The -g argument means that you are installing this module globally (available from any project).