rollingdonuts is Built on Radicles
Website Documentation Releases Community
- Your document root must be configurable (most local development tools and webhosts should support this)
- PHP >= 8.0 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 rollingdonuts projects to them.
💄 Visit the /welcome/
route for component demos
📦 Trellis
Run yarn && yarn build
Run php .rollingdonuts-setup/trellis.php
to grab the latest version of Trellis and apply the necessary modifications for rollingdonuts. After you've ran this script,
navigate to the Trellis directory to init and start your project:
$ php .rollingdonuts-setup/trellis.php
$ cd trellis/
$ trellis init
$ trellis up
You can remove the .rollingdonuts-setup/
directory after you've ran the Trellis script, or if you aren't planning to use Trellis.
🐳 Lando
- In
bud.config.js
: Replacehttp://rollingdonuts.test
withhttps://rollingdonuts.lndo.site
- Run
yarn && yarn build
- Run
lando start
- Visit
https://rollingdonuts.lndo.site/
You can run lando login
to generate a passwordless wp-admin login URL (WordPress must first be installed)
⚙️ Other
- In
bud.config.js
: Replacehttp://rollingdonuts.test
with your local dev server URL - Run
yarn && yarn build
- Run
composer install
- Configure your local development setup to set the
public/
directory as the webroot. - Copy
.env.example
to.env
and update the environment variables
📦 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:
- Run
yarn && yarn build
from the project root - Copy contents of
public/dist/
folder to server (produced fromyarn build
) - Run
wp acorn optimize
- Run
wp acorn icons:cache
(if using Blade Icons) - Run
wp login install --activate
(if wanting to use the WP-CLI login command)
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 |
While we strive to help our customers in any way we can, a rollingdonuts license doesn't cover the Roots team troubleshooting any application code issues that aren't directly related to rollingdonuts itself.
If you discover a bug in rollingdonuts, 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 #rollingdonuts channel on our Discord server.