Getting Started

Last Updated: 2021-02-08

Welcome! We're so glad you've chosen to spend time with Grouparoo.

For a quick glance at what Grouparoo is and does, check out our Declarative Sync video:

See below for more information on getting your own instance setup and running.

Try Grouparoo Now!

The quickest way to see Grouparoo in action is try it locally with Node.js.

Assuming you have Node.js (v12+) installed, all you have to do to get started is:

# in a new directory
npm install -g grouparoo
grouparoo init .
grouparoo start

Getting Started with Grouparoo

Like what you see?

Fantastic! Now, let's get Grouparoo running for you. There are a number of ways to run Grouparoo to fit your workflow. There are four steps to getting Grouparoo successfully running and deployed to production:

  1. Install
  2. Configure
  3. Run
  4. Deploy

Follow those links or use the nav on the left to work your way through setting up Grouparoo.

Understanding the Basics

Before you begin, it may be helpful to familiarize yourself with the core concepts from which Grouparoo operates.