Radicle is a WordPress stack from Roots

Website    Documentation    Releases    Community

Server requirements

• Your document root must be configurable (most local development tools and webhosts should support this)
• PHP >= 8.2 with the following extensions: BCMath, Ctype, Fileinfo, JSON, Mbstring, Tokenizer, XML
• Composer
• WP-CLI

If you are using a managed WordPress host, make sure that they meet these requirements if you're wanting to deploy your Radicle projects to them.

Getting started

📝 View the documentation

💄 Visit the /welcome/ route for component demos

Local development

📦 Trellis

Run yarn && yarn build

Run php .radicle-setup/trellis.php to grab the latest version of Trellis and apply the necessary modifications for Radicle. After you've ran this script, navigate to the Trellis directory to init and start your project:

$ php .radicle-setup/trellis.php
$ cd trellis/
$ trellis init
$ trellis up

You can remove the .radicle-setup/ directory after you've ran the Trellis script, or if you aren't planning to use Trellis.

🐳 Lando

1. In bud.config.js: Replace http://radicle.test with https://radicle.lndo.site
2. Run yarn && yarn build
3. Run lando start
4. Visit https://radicle.lndo.site/

You can run lando login to generate a passwordless wp-admin login URL (WordPress must first be installed)

⚙️ Other

1. In bud.config.js: Replace http://radicle.test with your local dev server URL
2. Run yarn && yarn build
3. Run composer install
4. Configure your local development setup to set the public/ directory as the webroot.
5. Copy .env.example to .env and update the environment variables

Deploying Radicle

📦 Trellis

Want to deploy with GitHub Actions? Uncomment the deploy job from .github/workflows/deploy.yml.

Otherwise, run trellis deploy <environment>.

⚙️ Other

You will need to make sure that your deployment process handles the following:

1. Run yarn && yarn build from the project root
2. Copy contents of public/dist/ folder to server (produced from yarn build)
3. Run composer install
4. Run wp acorn optimize
5. Run wp acorn icons:cache (if using Blade Icons)
6. Run wp login install --activate (if wanting to use the WP-CLI login command)

Places to be

Path	Description
config/post-types.php	Post types configuration
config/theme.php	Theme setup configuration
public/content/	wp-content directory
storage/logs/application.log	App log
resources/scripts/editor/	Block editor related scripts
resources/views/	Theme templates

Support

While we strive to help our customers in any way we can, a Radicle license doesn't cover the Roots team troubleshooting any application code issues that aren't directly related to Radicle itself.

If you discover a bug in Radicle, please make a topic on Roots Discourse with minimal reproduction instructions.

If you have feature requests, questions, or feedback, please make a topic on Roots Discourse or use the #radicle channel on our Discord server.