PHPackages scottjs/wp-boilerplate - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. scottjs/wp-boilerplate ActiveLibrary[Utility & Helpers](/categories/utility) scottjs/wp-boilerplate ====================== An empty WordPress boilerplate folder structure with initial composer packages. 1.2.0(9y ago)019MITPLSQL Since Apr 2Pushed 9y ago1 watchersCompare [ Source](https://github.com/scottjs/wp-boilerplate)[ Packagist](https://packagist.org/packages/scottjs/wp-boilerplate)[ RSS](/packages/scottjs-wp-boilerplate/feed)WikiDiscussions master Synced today READMEChangelog (2)Dependencies (4)Versions (15)Used By (0) WP Boilerplate ============== [](#wp-boilerplate) WP Boilerplate is an empty, themeless WordPress folder structure that we commonly use in our development environment to maintain project consistency. It is bundled with a collection of composer packages that allow you to quickly sync databases, run safe find/replace and enable unversioned uploads to load from a production server. *Disclaimer: This boilerplate was originally created for use internally within our development team to speed up common, repetitive tasks. However, they may be of some use to others. Feel free to use in your own projects, your mileage may vary.* Requirements ------------ [](#requirements) - Composer - PHP >= 5.3.9 - A local development environment, such as Vagrant. Notes ----- [](#notes) - The configuration for this boilerplate is inspired by Laravel 5's dotenv mechanism using .env files. - This setup has been designed to work within a Vagrant environment, it may work in other flavours as long as the project has its own host entry/vhost and isn't set up as a subdomain install. - Similar to Laravel and other frameworks, the WordPress files are stored in the `public` directory and this directory should be set as the document root for your project. - Ensure you have a host entry configured for the project. Companion Packages ------------------ [](#companion-packages) This repository comes with the following composer packages preloaded to provide additional features for this boilerplate: - [scottjs/wp-dotenv](https://github.com/scottjs/wp-dotenv) - Enables WordPress to use dotenv config files. - [scottjs/db-sync](https://github.com/scottjs/db-sync) - Scripts to quickly sync a remote database to a local database, as well as safe search/replace. - [scottjs/helper-scripts](https://github.com/scottjs/helper-scripts) - Other scripts to assist with common tasks, such as allowing remote uploads to load locally. Installation ------------ [](#installation) 1. Download/extract a copy of this repository to a location accessible by your local environment. 2. Copy, paste and rename `.env-sample` to `.env`. 3. Update the `.env` configuration options as necessary. 4. Within your environment terminal, browse to the project root, e.g. `cd /var/www/` 5. Run `composer install` to download the companion packages and install WP core. 6. Run `composer generate-config` or `composer generate-config-with-salts` to create a modified WordPress config that uses the .env config file. 7. Visit the project in your browser and continue to set up the local database as normal. 8. Install or build your theme and begin development. Usage ----- [](#usage) To use the features of the companion packages mentioned above, the following composer commands have been added to the `composer.json` file: - ***composer generate-config*** - All of the companion packages rely on the .env file to get their configuration. This command will generate a modified wp-config.php file to allow WordPress to also use the .env file and avoids having to maintain two config files. This requires `APP_DOCROOT` to be set in the .env file. - ***composer generate-config-with-salts*** - As above, but will also generate the salts automatically. This is a handy command to use when starting a new project, but it can be used at any time. - ***composer database-update*** - When working on an active project, your local database might be too out of date from the database in staging or production. This command will backup and empty your locally configured database and update it with copy of your remote or production database. This requires all `DB_*` and `REMOTE_DB_*` options to be set in the .env file and also assumes your remote database is accessible externally. - ***composer database-prepare*** - When developing locally, links to images and assets created within a CMS might be referencing your local development web address and won't work in staging or production. This command will run a safe search/replace script on your locally configured database, replacing all instances of `DOMAIN_LOCAL` with `DOMAIN_REMOTE` configured in the .env file. The database will then be exported to `dumps/prepared-database-YYYY.MM.DD-HH.MM.SS.sql` ready for deployment. - ***composer database-import*** - If the file `setup/database.sql` exists in the project root, this command will import the file into your local database configured in the .env file. This is useful if you're working on a project and want another member of the team to get quickly set up with working copy of the database. - ***composer database-export*** - This command will export a copy of your local database configured in the .env file and save it to `setup/database.sql`. If this file exists it will be overwritten. This is useful to quickly take a snapshot of your current development database to be shared with others. - ***composer remote-uploads-enable*** - When developing locally on an active project, it's likely that the main uploads folder is not bundled within your repository, causing CMS uploaded images not to load. This command will install a local .htaccess file in your configured uploads directory and will redirect all requests to the remote server instead. This requires `DOMAIN_REMOTE`, `APP_DOCROOT` and `APP_UPLOADS` to be set in the .env file. It's recommended to ignore this .htaccess file from your project repository. - ***composer remote-uploads-disable*** - A convenient helper command to remove the .htaccess file created by the command above just in case you find it causes issues. This assumes that the .env configuration hasn't changed since it was added. Config ------ [](#config) See below for an explanation of each configuration option used within the .env file. - ***DOMAIN\_REMOTE*** - Required by ***composer database-prepare*** and ***composer remote-uploads-enable***, it should point to your remote or production environment (if available) and not include http:// or trailing slashes. Example: `www.example.com` or `subdomain.example.com`. - ***DOMAIN\_LOCAL*** - Required by ***composer database-prepare***, it should not include http:// or trailing slashes. Example: `www.example.local` or `subdomain.example.local`. - ***APP\_DOCROOT*** - Required by ***composer generate-config*** and ***composer remote-uploads-enable***, it should be relative to your project root folder and point to where the document root is configured. It should start with a slash and not include a trailing slash. Leave blank if not applicable. Example: `/public`. - ***APP\_CORE*** - Required only if using the wp-config.php file generated by ***composer generate-config*** and if WP core files are located in a subdirectory. It should point to the directory where WP core is installed relative to `APP_DOCROOT`. It should start with a slash and not include a trailing slash. Leave blank if not applicable. Example: `/wp`. - ***APP\_UPLOADS*** - Required by ***composer remote-uploads-enable*** and should point to the URL where remote uploads are located relative to `DOMAIN_REMOTE`. It should start with a slash and not include a trailing slash. Example: `/wo-content/uploads`. - ***APP\_DEBUG*** - Required only if using the wp-config.php file generated by ***composer generate-config***. Allows you to enable or disable WP debugging. Options: `true` or `false`. - ***APP\_WWW*** - Required only if using the wp-config.php file generated by ***composer generate-config***. Allows you to force WordPress to redirect to www or non-www web addresses. Options: `true` or `false`. - ***APP\_SSL*** - Required only if using the wp-config.php file generated by ***composer generate-config***. Allows you to force WordPress to use the SSL protocol handle redirection. Options: `true` or `false`. - ***DB\_***\* - Required by ***composer update-database*** and provides options to set the local database connection details. - ***REMOTE\_DB\_***\* - Required by ***composer update-database*** and provides options to set the remote staging or production database connection details. ### Health Score 29 — LowBetter than 57% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community7 Small or concentrated contributor base Maturity71 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~25 days Recently: every ~76 days Total 13 Last Release 3434d ago Major Versions 0.4.4 → 1.0.02016-04-05 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/994732?v=4)[Scott Salisbury](/maintainers/scottjs)[@scottjs](https://github.com/scottjs) --- Top Contributors [![scottjs](https://avatars.githubusercontent.com/u/994732?v=4)](https://github.com/scottjs "scottjs (56 commits)") ### Embed Badge ![Health badge](/badges/scottjs-wp-boilerplate/health.svg) ``` [![Health](https://phpackages.com/badges/scottjs-wp-boilerplate/health.svg)](https://phpackages.com/packages/scottjs-wp-boilerplate) ``` ### Alternatives [altis/cms CMS Module for Altis 46225.8k2](/packages/altis-cms) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)