Get started

These pages will help you get started building a Root App. By the end of this section, you'll be able to:

• Set up your development machine and Root account.
• Accurately describe the components of a Root App and the function of each.

📄️ 1. Overview

A Root App (App) is a full-featured software application that brings new functionality to a Root community. As a developer, you build Root Apps and publish them in the Root Store. Community administrators install Apps from the Store into their communities. Each App runs inside its own channel, and members can jump in anytime to interact with it.

📄️ 2. Setup

You can develop for the Root Platform on Windows or macOS. You'll need to do a few Root setup tasks before starting to write code. Skip any steps that you've completed previously.

📄️ 3. Generate starter code

Root supplies a command-line utility named create-root that generates starter code. You'll need npx installed on your machine in order to run the tool (npx is included with Node).

📄️ 4. Build your App

Building an App with Root requires a few key steps to set up your App's test environment and compile your project. In this guide, we’ll walk you through adding your DEV_TOKEN to your server project and compiling your App’s source code. After going through these steps, your App will be ready to run locally.

📄️ 5. Test your App

Root supports testing your App locally. Both your App's client and server are hosted on your local machine.

📄️ 6. What's next?

You're ready to start building. Your dev setup is done, your Root account is active, and you've seen how Root code is organized.