Installing Dialtone Locally

A more thorough guide for installing Dialtone locally.

First things first: we're excited you want to install Dialtone locally as this most likely means you'll be contributing soon! Before you get to get started though, please make sure you've read our contributing docs.

The below instructions assumes a brand new build. If you've Node.js and NPM for other projects, please skip ahead.

Install Node & NPM

To run Dialtone locally, you must have Node and NPM (Node Packet Manager) installed. Click here to download Node. The recommended Node version is fine. NPM is included with Node. If you already have Node installed, you may move onto the next step.

Once Node finishes installing, ensure it is installed properly by typing the following command in your Terminal window:

node -v

You should see the following response:

v12.18.2

Clone project repo

Download the repo to your machine:

// SSH
git clone git@github.com:dialpad/dialtone.git

// HTTPS
git clone https://github.com/dialpad/dialtone.git

Then cd into the Dialtone directory:

cd ./path/to/dialtone

Install Gulp & project dependencies

Dialtone uses Gulp to automate its various workflows. Run the following command to install Gulp and all other project dependencies:

npm run setup

Building Dialtone

You're now ready to build Dialtone! To build build, run npm start. Once finished, visit http://localhost:4000/.