Architect plugin for Craft CMS 3/4

A plugin for importing and exporting content models from Craft CMS using JSON.

Related: Architect for Craft 2.x

Requirements

This plugin requires Craft CMS 3/4.

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

   cd /path/to/project
   

2. Then tell Composer to load the plugin:

   composer require pennebaker/craft-architect
   

3. a. In the terminal run

   ./craft plugin/install architect
   

   or

   b. In the Control Panel, go to Settings → Plugins and click the “Install” button for Architect.

Architect Overview

The architect can import and export just about anything in craft that needs to be configured. ex. It can help with migrations by adding new fields needed by a structuring update and export existing fields for use on another website.

Configuring Architect

There isn't much to configure in Architect right now.

JSON Schema

The example / syntax schemas are located on the Repo's Wiki

If you're using the Atom text editor, you can download a snippet library to help speed up your writing custom models for the plugin. (Might not be updated for the Craft 3 version of architect yet)

You can also use YAML if you prefer.

Build Order

This is used to process blueprint files in a specific order. The files path is in relation to config/architect. They can be either a json or yaml file.

{
  "buildOrder": [
    "assets.json",
    "blog.yaml"
  ]
}

Using Architect

Visit architect in the admin CP for importing / exporting just about anything using JSON.

Current Working Imports:

• Site Groups
• Sites
• Routes
• Sections
• Entry Types
• Asset Volumes
• Asset Transforms
• Tag Groups
• Category Groups
• Field Groups
• Fields
• Global Sets
• User Groups
• Users

Current Working Import and Update:

• Fields

Current Working Exports:

• Site Groups
• Sites
• Routes
• Sections
• Entry Types
• Asset Volumes
• Asset Transforms
• Tag Groups
• Category Groups
• Field Groups
• Fields
• Global Sets
• User Groups
• Users

Architect Roadmap

Some things to do and ideas for potential features:

[2.0.0] complete

• Importing

[2.1.0] complete

• Exporting

[2.2.0] complete

• Importing Users
• Exporting Users

[2.3.0] complete

• Importing Routes
• Exporting Routes
• YAML Support
• Command Line Importing
• Build order importing
• Import and Update Fields

[2.4.0] complete

• Craft 3.5 Field Layout

[x.5.0 and later] brainstorming

• Import and Update (Non Fields)
• Commerce Support
• Store for sharing blueprints

Brought to you by Pennebaker