Configure WP Rig for your project

To get WP Rig up and running in your development environment, you have to make some configurations. These configurations are not permanent, they only relate to WP Rig in the current theme development environment, and they can be changed at any time, but some of them are necessary for things to work properly.

All the configurations are found under the “config” folder. Here you have three files, config.default.json, config.json, and themeConfig.js. This last file is the file that makes the configurations possible, so you never touch it.

The files that are relevant to us are the two first ones, config.default.json and config.json. Config.default.json provides the default configuration settings, and works as a fallback. Any custom configurations for your project are placed in config.json, which is currently empty. This file will automatically override the default settings.

To show you how this works, let’s set up a custom theme slug, theme name, and author name. The easiest way to do this is simply go to config.default.json, highlight everything and copy it out, and then paste it in to config.json. Now remember, this file overrides whatever is in config.default.json. Now that you have everything, you can just delete anything you don’t need,

Then, say the only things you care about are the slug, the name, and the author — then you can change them to anything you want. Any new configuration settings will override what’s in config.default.json, but everything else that sits in that file will remain as fallback.

One final note: config.json is tracked by Git and will sync to Github. If you’re working on a project with other developers and you want to set up a local configuration that only relates to one particular computer — the one you’re working with or a specific dev environment — you can also create a file called config.local.json. That file will not be synced across Git, it will only belong to your local install. It will also override anything that’s in config.json, so that way you can have a local setup, a global setup for the shared environment, and the default setup all at the same time.

More from this course: