To get started with Propulsion, first head over to the GitHub repo and select the Use this template button to quickly create your own copy of the repo, otherwise, download the project as a ZIP package under the Code dropdown.

System Requirements

Propulsion requires Node.js to be installed in order to run.

If you do not have Node.js installed already, DigitalOcean maintains a curated list of installation instructions for various operating systems.

All other dependencies will be installed in the next section.

Install Dependencies

Once you have your copy of Propulsion downloaded to your computer, open up the directory in a command prompt and run the following command:

npm install

The installation will download and install all necessary dependencies into a node_modules directory in the project folder.

Running Locally

To work on your copy of Propulsion locally, open the project folder in the text editor of your choice.

Then, to run the project, run the following command:

npm start

This command will build the project and start a server, which is accessible at localhost:8080. Open that URL in a browser to review and test design system build.