salaros/mr-press

Mr. Press is a WordPress development stack similar to Bedrock. Project's main goal is to improve the overall security, portability and deployment process of WordPress, while trying to use the best web development practices.

0.7.6 2017-06-25 22:57 UTC

README

Latest Stable Version Dependency Status Packagist License Gitter

Mr. Press is a WordPress development stack similar to Bedrock. Project's main goal is to improve the overall security, portability and deployment process of WordPress, while trying to use the best web development practices.

Features

  • WordPress, its themes and plugins are installed and updated via Composer!
  • wp-content folder has been relocated, so it won't mess up with WordPress core
  • Critical WordPress settings (such as site URL, database credentials etc) are loaded from the environment variables
  • WP Cron is disabled by default and there is a ready-to-use cron job to run

Mr. Press default theme's features

  • Bootstrap responsive layout
  • Clean templates using Twig templates via Timber plugin
  • A lot of customizations can be done directly from code:
    • define menus (links to page, custom links, nested items etc)
    • add / remove custom post types and taxonomies
    • handy access to Bower and NPM assets
  • Integration with Advanced Custom Fields plugin (group fields can be registered from theme code) and used via Timber

Requirements

Make sure that Composer and the rest of the requirements are installed.

Installation

Just go the web root folder (usually it's /var/www) and create your copy of the project:

$ cd /var/wwww
$ composer create-project salaros/mr-press my-new-website

Create WordPress tables

Now change to /var/www/my-new-website directory and edit the .env file and chnage DB connection settings and site URL:

$ cd /var/www/my-new-website
$ editor .env
$ composer run-script initialize

Create cron job

Since WP Cron is disabled by default you'd better run the commands below in order to enable a system cron job which triggers WP Cron every 5 min:

PLEASE NOTE: create-cron-job requires administrator privileges, so you should run it as root (super user) or sudoer user.

$ cd /var/www/my-new-website
$ composer run-script create-cron-job

Contributing

  1. Fork it: https://github.com/salaros/mr-press
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request 🐻

Known bugs

  • Mr. Press has been tested on Linux and might also work correctly on Mac OS X. Windows compatibility will be implemented later
  • Most likely Mr. Press is not compatible with WordPress multisie, but this feature has been already added to the RoadMap

License

The MIT License (MIT). Please see License File for more information.

Credits

TODO: Write credits