Setting Up

This tutorial is intended for new users who want detailed instructions on how to build a basic Runnerty project. ๐Ÿš€ Let's start!



Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.


Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open Terminal on a Mac, Linux, or Unix system. Open Git Bash on a Windows system.
  2. If you have brew on your OS, run the following command to install Node.
brew install node

Alternatively, you can download an installer from the Node.js homepage.

Check your Node.js installation

Check that you have the minimum required version installed by running the following command:

node -v

You should see a version larger than Node 12.

node -v

Runnerty v2 minimum supported Node.js version is Node 12, but more recent versions will work as well.

Runnerty (optional)

For this setup it is not necessary to install runnerty (it has been included as a dependency to simplify the process) but it is recommended to install it when you want to advance a little more.

  1. Open Terminal and simply runs this command:
npm install -g runnerty

You should see a version.

runnerty -v
Runnerty 2.*.*

Here you have more information about the use of runnerty in the terminal