Getting Started

Start with our recommended boilerplate

• Radicle is our opinionated starting point for WordPress projects with the Roots stack. It combines Acorn, Bedrock, Sage, and Trellis into a single package to provide a streamlined development experience. Use Radicle when you want a ready-to-go solution that incorporates best practices from all Roots projects.

What to know about each project

Each Roots project serves a specific purpose in the WordPress development workflow. Here's a brief overview of when to use each:

• Acorn is ideal when you want to integrate Laravel in your WordPress projects. It's a framework that includes Laravel's features like routing, Blade templates, migrations, models, and more.

• Bedrock is ideal for managing WordPress installations, especially in git. It uses Composer for dependency management and follows a more structured project layout, making it suitable for larger projects and teams.

• Sage is a hybrid WordPress starter theme that utilizes modern front-end development tools. Use Sage when you want to create custom WordPress themes with a focus on performance, maintainability, and developer experience.

  Sage includes Acorn as a dependency out of the box for Blade views, view composers, and asset management

• Trellis is a local development, server provisioning, and deployment tool for WordPress projects. Use Trellis when you need to automate the setup and management of your WordPress hosting environment, ensuring consistency across development, staging, and production servers.

  Trellis requires a Bedrock-based WordPress site which is automatically created on new projects

Does each project work independently?

While each Roots project is designed to work independently, they are also built to integrate seamlessly with one another. This means you can use them individually or in combination, depending on your project's needs:

Example usage scenarios

• Use Acorn to build packages, plugins, or themes that leverage Laravel features within WordPress
• Use Bedrock to manage a WordPress site
• Use Bedrock Acorn to add Laravel functionality to your Bedrock site
• Use Sage to create hybrid WordPress themes
• Use Trellis to automate the setup of your local and remote WordPress environments
• Use Trellis to only setup a local development environment
• Use Trellis to only deploy your Bedrock sites
  Use Trellis to deploy to managed hosts such as Kinsta
• Use Trellis to provision and deploy to your remote servers, using your own local development environment of choice, such as Laravel Valet

Additional projects

In addition to the core Roots projects, we also maintain several other plugins and packages that complement our main offerings. These include:

• roots/acorn-example-package — A template for creating your own Acorn packages
• roots/acorn-fse-helper — Acorn package to bootstrap FSE support in Acorn or Sage-based themes
• roots/acorn-mail — Acorn package for simple WordPress SMTP configuration
• roots/acorn-prettify — Acorn package that cleans up WordPress markup
• roots/post-types — Acorn package for simple post types and taxonomies configuration using Extended CPTs
• roots/allow-svg — WordPress plugin that enables SVG uploads with validation
• roots/bedrock-autoloader — Enables standard plugins to be required just like must-use plugins
• roots/bedrock-disallow-indexing — Disallow indexing of your site on non-production environments
• roots/post-content-to-markdown — WordPress plugin that serves post content as Markdown via Accept headers or query parameters
• roots/setup-trellis-cli — Sets up Trellis for GitHub Action workflows
• roots/sync-script — Synchronize your WordPress site database and uploads between environments with WP-CLI aliases and rsync
• roots/wordpress — Composer package that provides WordPress core installation
• roots/wp-stage-switcher — WordPress plugin for Bedrock sites that adds a menu item to the WP admin bar for switching between environments