rbdwllr/wordpress-starter

There is no license information available for the latest version (0.1.0-alpha.3) of this package.

WordPress Composer Starter Repo

Maintainers

Details

github.com/RobDWaller/wordpress-starter

Source

Issues

Installs: 11

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 1

Forks: 2

Open Issues: 12

0.1.0-alpha.3 2018-04-10 12:28 UTC

Requires

Requires (Dev)

Unknown License 1bfe9f7ed9abf18d62ab011d34923f906b4c5694

  • Rob Waller <rdwaller1984.woop@googlemail.com>

This package is auto-updated.

Last update: 2024-04-11 19:22:42 UTC

README

A simple Wordpress starter repo that uses Composer to install WordPress, plugins, themes and vendor packages. The wp-config has been extended so that it is powered by PHP DotEnv and makes use of .env files which are much better for deployments.

WordPress is pulled in from JohnPBloch's WordPress packagist project that reflects the latest release of WordPress.

Thanks must go to Chris Sherry for his excellent tutorial on modern WordPress development that inspired this project two years ago. See Chris' talk from PHP UK 17 to learn more about this subject.

System Requirements

  • PHP >= 7.0
  • Yarn (Node, NPM)
  • Composer
  • MySQL

Installation

To install the WordPress starter run the following Composer command:

// For now just use dev-master while this project is in alpha

composer create-project --prefer-dist rbdwllr/wordpress-starter test dev-master

If you download the project manually it will include some testing features such as Behat and Travis that may be of no interest to you and you may need to delete them.

DotEnv Setup

After the composer create-project command is run your .env file will be created automatically based on the .env.example file. Also the relevant WordPress salts and keys will be appended to the end of the .env file via the wordpress-salts-generator library.

You will need to edit the .env file to match your specific environment in regards to database, etc.

If you have installed this package manually rather than via Composer we advise that you just copy the .env.example file. Also you can append the required salts to the end of .env file using this following command:

vendor/bin/wpsalts dotenv --clean >> .env

Yarn Setup

This project makes use of Yarn rather than NPM directly, we find Yarn generally works better.

To install the required dependencies run the following command:

yarn install

Once Yarn has installed all the required dependencies you can build your JavaScript and SASS files by running the below command. Note you will need to run this command to get the base theme working.

yarn run dev

Theme

The WordPress starter project comes with a pre-built base theme stored in the ./public/wp-content/themes/project-theme directory.

This theme is turned on by default in the wp-config.php file. See the constant WP_DEFAULT_THEME.

We have tightly coupled the theme to the project so that JavaScript and SASS files can be built at the root level as this makes site deployments far easier.

Authors