wemakecustom/wp-skeleton

Wordpress skeleton using composer, bower, plugin dependencies and various config files

v1.1 2015-12-07 20:52 UTC

README

Thin wrapper around wp-skeleton-installer to easly install WordPress and get it works.

What it does

Install selected plugins and a custom theme for a clean starting WordPress:

Install libraries for an easy custom integration:

  • bootstrap (version ~3.0) is a front-end framework for faster and easier web development.
  • font-awesome (version ~4.0) is an iconic font for easy scalable vector graphics.
  • jquery (version <2.0) is the most used javascript library.
  • modernizr (version ~3.0) is a javascript library that detects HTML5 and CSS3 in user browser.
  • underscore provides a lot of useful javascript helpers.
  • console-polyfill is a light library to makes it safe to do console.log().

Installation

$ git clone git@github.com:wemakecustom/wp-skeleton.git <project>
$ cd <project>
$ composer install

If you doesn't need the wp-skeleton-theme-demo theme:

$ composer install --no-dev

By default, at the end, you will get WordPress and all configs files installed in <project>/htdocs/ subfolder. To configure another subfolder, please see section configuration bellow.

After that, you have to create the WordPress tables in the database with wp-cli, a command-line tools for managing WordPress. You can read more information here about wp core install command.

$ bin/wp core install --path=htdocs/ --url=<url> --title=<site-title> --admin_user=<username> --admin_password=<password> --admin_email=<email>

Then, finish by running bower to get all recent script up to date in <project>/htdocs/wp-content/components/.

$ bower install

Configuration

The following section in composer.json allow you to change the folder where WordPress and the config files are installed. For details about this section, please see wp-skeleton-installer.

{
    "extra": {
        "wordpress-install-dir": "vendor/wordpress/wordpress",
        "web-dir": "htdocs",
        "installer-paths": {
            "htdocs/wp-content/plugins/{$name}/": ["type:wordpress-plugin"],
            "htdocs/wp-content/mu-plugins/{$name}/": ["type:wordpress-muplugin"],
            "htdocs/wp-content/themes/composer/{$name}/": ["type:wordpress-theme"]
        }
    }
}