Configuration

Last Updated: 2021-06-23

After you've installed Grouparoo locally, you're ready to configure it. The easiest way to configure Grouparoo is with the help of Grouparoo's UI Config plugin. Here's a quick overview of the development workflow:

If you're using Grouparoo's Enterprise Edition, we recommend that you follow the same workflow by creating and testing your config files locally first before deploying changes with @grouparoo/ui-config. That said, you are also able to create new config objects directly on your production server as well, using live data immediately. See here for more information on configuration objects with Grouparoo's Enterprise Edition.

Getting Started with UI Config

UI Config is the recommended way to configure your Grouparoo data. It requires the @grouparoo/ui-config plugin. This is included by default when you initialize Grouparoo with grouparoo init. If you don't have it as a dependency because you are updating from an older version of Grouparoo, you can install it with the install command:

# If you are upgrading from Grouparoo v0.4.x or earlier
$ grouparoo install @grouparoo/ui-config

To start the UI Config application, use the config CLI command:

$ grouparoo config

This will start the UI Config application and open your browser to the appropriate location.

Creating Config Objects

The UI Config helps you through the process of creating configuration objects for your Grouparoo application. As you make changes in UI Config, Grouparoo will write files to your config directory in your Grouparoo project.

When then running Grouparoo's main application in development or production mode, these files will be loaded into the system and used as your application's configuration.

Config Guides

There are a handful of guides to help you through the configuration process with UI Config:

Using the CLI

You can also use Grouparoo's CLI to generate config files. See Code Config for more information on generating config files on the command line.