A CLI tool to quickly set up a WordPress project with the TKTK theme and blocks.
This tool automates the installation of WordPress, configures Valet, installs the theme and block plugin, and prepares your development environment.
Ensure you have the following installed on your system:
- Node.js (LTS version recommended)
- Valet (for local development)
- WP-CLI (for managing WordPress installations)
To create a new WordPress project using TKTK:
npx tktk-setupYou'll be prompted to enter:
- Project Name (directory for WordPress installation)
- Theme Name (default:
my-theme) - Blocks Plugin Name (default:
my-blocks)
After installation, you'll see setup details, including the local site URL, admin login, and next steps.
npx tktk-setup- Installs WordPress
- Links it to Valet (
valet link) - Installs the TKTK theme and blocks plugin
- Builds assets for the theme and plugin
Once your project is installed, navigate to the project folder:
cd my-projectcd wp-content/themes/my-theme && npm run devcd wp-content/plugins/my-blocks && npm run devYour changes will update automatically with hot reloading.
Ensure tktk-setup is installed globally:
npm list -g --depth=0 | grep tktk-setupIf not installed, reinstall it:
npm install -g tktk-setupIf your site isn’t loading:
valet restart
valet secure my-projectRun:
wp core install --url=http://my-project.test --title="My Project" --admin_user=admin --admin_password=password --admin_email=admin@example.com- tktk
Developed by [Britton Walker / Athletics].
Contributions and suggestions welcome! 🚀