Skip to content

philipjohn/o-neill

Repository files navigation

O'Neill

O'Neill is a template for managing WordPress development projects with Git and Composer.

Premise

Version control your code through Git but without including WordPress or any dependent plugins and themes, leaving that to Composer. The basic premise is thus;

  • Your composer.json, custom plugins/themes are tracked by Git
  • Setting up your WordPress install, and installing required plugins, are handled by Composer

Usage

  1. Clone or download this repo
  2. Get rid of the .git directory (if you cloned) to remove the template's history
  3. Rename gitignore to .gitignore
  4. Open up .gitignore and uncomment lines 6 and 10-15
  5. Remove the example plugins from composer.json, if you want to (DON'T remove WordPress)
  6. git init
  7. git add *
  8. git commit -m "First commit"
  9. composer install to install WordPress and any dependent plugins/themes
  10. Open up secrets/environment.php and check which environment you want to set
  11. Open up secrets/keys.php and provide new salts and database credentials
  12. Develop your project, adding your custom plugins/themes as relevant
  13. Update .gitignore to make sure that your custom code isn't ignored

Once you've got a working project, deploying it elsewhere should be as easy as;

git clone git@gitremote.com:your-project.git your-project
cd your-project
composer install

Included in this template's composer.json are two excellent plugins from @johnbillion to demonstrate how you can include your dependent plugins.

O'Neill?

What is a developer to do when he can't think of a name for his little project? Yes, that's right, leverage his love of sci-fi franchise Stargate. O'Neill is named after Colonel Jack O'Neill of SG-1, because geek.

Credits

Kudos to the Roots primer on Composer & WordPress for the inspiration.

About

Manage WordPress development projects with Git and Composer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published