Start Project
Make sure Docker is running before you start. WordPressify automatically checks for Docker and will show a clear error message if it is not active.
File Structure
src/theme/- PHP/HTML template files for the WordPress theme.src/plugins/- Custom WordPress plugins.src/assets/css/- CSS stylesheets.src/assets/fonts/- Font files.src/assets/img/- Image assets.src/assets/js/- JavaScript files.
Configuration files, Docker files, and build scripts live in the project root.
Change Template Name
Rename .env_example to .env to customize your settings. Both variables have sensible defaults, so the .env file is optional if you are happy with the defaults:
# If you want to connect to BrowserSync on a different port. Default: 3010
PROXY_PORT=3010
# Theme name. Default: "wordpressify"
THEME_NAME=wordpressifyThis name is used for the theme directory in WordPress and in the exported zip file.
Start Workflow
Start the development server
npm run startIf Node.js is not installed locally, use Docker directly:
docker compose upRebuild environment
To rebuild with a fresh WordPress installation and clean database:
npm run rebuildWithout local Node.js:
docker compose down -v && docker compose buildAdd WordPress plugins
Place custom plugins in the src/plugins/ directory. They are automatically copied into the WordPress plugins folder during the build.
Export for production
Generate optimized distribution files:
npm run exportWithout local Node.js:
docker compose run --rm nodejs npm run prodThe theme is saved as a zip file in dist/wordpressify.zip.