From 0001209373bf12c92f92c667cb903f1af03971a2 Mon Sep 17 00:00:00 2001 From: Vincent Klaiber Date: Fri, 15 May 2015 22:09:26 +0200 Subject: [PATCH 1/4] Move documentation to website --- README.md | 100 +++++------------------------------------------------- 1 file changed, 8 insertions(+), 92 deletions(-) diff --git a/README.md b/README.md index 8224efdf..f74c1804 100644 --- a/README.md +++ b/README.md @@ -9,108 +9,24 @@ A [WordPress](https://github.com/WordPress/WordPress) boilerplate. This project [![Latest Version](https://img.shields.io/github/release/wordplate/wordplate.svg?style=flat)](https://github.com/wordplate/wordplate/releases) [![License](https://img.shields.io/packagist/l/wordplate/wordplate.svg?style=flat)](https://packagist.org/packages/wordplate/wordplate) -## Install Composer -WordPlate utilizes [Composer](https://getcomposer.org/) to manage its dependencies. So, before using WordPlate, you will need to make sure you have Composer installed on your machine. +## Installation -## Install WordPlate -First, download the WordPlate installer using Composer. +Install WordPlate by issuing the Composer `create-project` command in your terminal: ```bash -composer global require wordplate/installer +composer create-project wordplate/wordplate --prefer-dist ``` -Make sure to place the `~/.composer/vendor/bin` directory in your PATH so the `wordplate` executable can be located by your system. +Read more about setting up WordPlate in our [installation documentation](https://wordplate.org/docs/installation) page. -Once installed, the simple WordPlate new command will create a fresh WordPlate installation in the directory you specify. For instance, `wordplate new acme` would create a directory named acme containing a fresh WordPlate installation with all dependencies installed. This method of installation is much faster than installing via Composer: +## Documentation -```bash -wordplate new acme -``` - -### Via Composer Create-Project -You may also install WordPlate by issuing the Composer create-project command in your terminal: - -```bash -composer create-project wordplate/wordplate acme -``` - -## Environment - -Add the database credentials and [salts](https://api.wordpress.org/secret-key/1.1/salt) to the `.env` configuration environment file. - -``` -DB_HOST=localhost -DB_NAME=wordpress -DB_USER=homestead -DB_PASSWORD=secret -``` - -## Install WordPress - -Open up your browser and visit the project URL with `/wordpress/wp-admin/install.php` to install WordPress. - -Thats it. We're done. Lets build stuff! +WordPlate's documentation has been moved to https://wordplate.org/ You can [find it there](https://wordplate.org/docs/installation/). -> Please note that if you aren't running your installation from the root you'll have to update [WP_CONTENT_URL](wp-config.php) in `wp-config.php`. - -## Plugins & Themes - -We are using [WordPress Packagist](http://wpackagist.org/) for plugins. To add a plugin from the [WordPress Plugin Directory](https://wordpress.org/plugins/) add the to the required array in the [composer.json](composer.json) file. Specify them with `wpackagist-plugin` following by the plugin slug name. Example below. - -```json -"wpackagist-plugin/wp-sweep": "~1.0" -``` +## Contributing -Please note that this also works with themes and WordPress multi-site plugins. - -## Templating -Library configuration can be edited in the `wp-content/themes/wordplate/config` directory. Visit [wp-custom-post-type-class](https://github.com/jjgrainger/wp-custom-post-type-class) to read about adding custom post types. Custom post types can be added within the `wp-content/themes/wordplate/includes/post-types` directory. - -The boilerplate doesn't include a way to create custom fields. Instead use [Advanced Custom Fields](http://www.advancedcustomfields.com/). It is specified by default in our `composer.json` file. - -## Pages -This boilerplate allows you to create WordPress pages trough the configuration files. You can eveb specify which template the page should use, if it has a parent and if it should act as the home or blog page. Accepted parameters: `title`, `type`, `template` and `parent`. Example below. - -```php -[ - 'title' => 'Start', - 'type' => 'home', -], -[ - 'title' => 'About', - 'template' => 'pages/about.php', -], -[ - 'title' => 'Archive', - 'type' => 'blog', - 'parent' => 'About', -], -``` - -## What's included? - -WordPress as a dependency. Move your content out of WordPress core. - -[WordPress Packagist](http://wpackagist.org/). Instead of installing plugins manually, specify them in the `composer.json`, they will added to the plugins directory automatically. - -A boilerplate theme filled with actions and filters to get the most out of WordPress. - -[Vance Lucas's](https://github.com/vlucas) great [PHP dotenv](https://github.com/vlucas/phpdotenv) package. Which loads environment variables from `.env` to `getenv()`, `$_ENV` and `$_SERVER` automagically. - -[TinyPNG](https://wordpress.org/plugins/tiny-compress-images/) - Speed up your website. Optimize your JPEG and PNG images automatically with TinyPNG. - -[Lester Chan's](https://github.com/lesterchan) WP-Sweep plugin. It allows you to clean up unused, orphaned and duplicated data in your WordPress. It also optimizes your database tables. - -[Joe Grainger's](https://github.com/jjgrainger) super [Custom Post Type Class](https://github.com/jjgrainger/wp-custom-post-type-class). It simplifies the way we do custom post types. - -[Laravel's](http://laravel.com/) string and array [helper functions](http://laravel.com/docs/master/helpers). It gives use useful helpers that isn't included in PHP out of the box. - -[Roots](https://github.com/roots) [soil](https://github.com/roots/soil) plugin, clean up WordPress markup, use relative URLs, nicer search URLs, and disable trackbacks. - -A Server Settings page. This page lists server configuration. Instead of login in to the server you can visit this page to get the necessary information. Located under *Settings > Server*. +Please review our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request. ## License -WordPlate icon made by [Andrey Vasiliev](https://thenounproject.com/andvasiliev/) licensed under [Creative Commons – Attribution (CC BY 3.0)](http://creativecommons.org/licenses/by/3.0/us/) - WordPlate is licensed under [The MIT License (MIT)](LICENSE). From 951fd2a65abad54297356022b2c52d73586643a9 Mon Sep 17 00:00:00 2001 From: Vincent Klaiber Date: Thu, 14 May 2015 19:49:05 +0200 Subject: [PATCH 2/4] Add mail configuration This closes #100 --- .env.example | 7 +++- composer.json | 2 +- config/mail.php | 86 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 93 insertions(+), 2 deletions(-) create mode 100644 config/mail.php diff --git a/.env.example b/.env.example index 7f8fddb2..0d4253b3 100644 --- a/.env.example +++ b/.env.example @@ -7,7 +7,12 @@ DB_NAME=wordpress DB_USER=homestead DB_PASSWORD=secret -GOOGLE_ANALYTICS_ID= +MAIL_HOST=mailtrap.io +MAIL_PORT=2525 +MAIL_USERNAME=null +MAIL_PASSWORD=null + +GOOGLE_ANALYTICS_ID=null AUTH_KEY=yourrandomstring SECURE_AUTH_KEY=yourrandomstring diff --git a/composer.json b/composer.json index 8532769e..66194398 100644 --- a/composer.json +++ b/composer.json @@ -10,7 +10,7 @@ } ], "require": { - "wordplate/framework": "2.4.*", + "wordplate/framework": "2.5.*@dev", "wpackagist-plugin/advanced-custom-fields": "~4.0", "wpackagist-plugin/tiny-compress-images": "~1.0", "wpackagist-plugin/wordpress-importer": "~0.6", diff --git a/config/mail.php b/config/mail.php new file mode 100644 index 00000000..c94644cb --- /dev/null +++ b/config/mail.php @@ -0,0 +1,86 @@ + env('MAIL_HOST', 'smtp.mailgun.org'), + + /* + |-------------------------------------------------------------------------- + | SMTP Host Port + |-------------------------------------------------------------------------- + | + | This is the SMTP port used by your application to deliver e-mails to + | users of the application. Like the host we have set this value to + | stay compatible with the Mailgun e-mail application by default. + | + */ + + 'port' => env('MAIL_PORT', 587), + + /* + |-------------------------------------------------------------------------- + | Global "From" Address + |-------------------------------------------------------------------------- + | + | You may wish for all e-mails sent by your application to be sent from + | the same address. Here, you may specify a name and address that is + | used globally for all e-mails that are sent by your application. + | + */ + + 'from' => [ + 'address' => null, + 'name' => null, + ], + + /* + |-------------------------------------------------------------------------- + | E-Mail Encryption Protocol + |-------------------------------------------------------------------------- + | + | Here you may specify the encryption protocol that should be used when + | the application send e-mail messages. A sensible default using the + | transport layer security protocol should provide great security. + | + */ + + 'encryption' => 'tls', + + /* + |-------------------------------------------------------------------------- + | SMTP Server Username + |-------------------------------------------------------------------------- + | + | If your SMTP server requires a username for authentication, you should + | set it here. This will get used to authenticate with your server on + | connection. You may also set the "password" value below this one. + | + */ + + 'username' => env('MAIL_USERNAME'), + + /* + |-------------------------------------------------------------------------- + | SMTP Server Password + |-------------------------------------------------------------------------- + | + | Here you may set the password required by your SMTP server to send out + | messages from your application. This will be given to the server on + | connection so that the application will be able to send messages. + | + */ + + 'password' => env('MAIL_PASSWORD'), + +]; From 0e46c488f6ab6d0e38c5ac6fbfcc34597f018003 Mon Sep 17 00:00:00 2001 From: Vincent Klaiber Date: Thu, 21 May 2015 12:54:25 +0200 Subject: [PATCH 3/4] Add version 2.5.0 to changelog --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index fa93f75b..39a9e0b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # CHANGELOG +## 2.5.0 (released 2015-05-21) + +- Fix Permalink Update Method Bug (#104) +- Move Docs to Website (#102) +- Add Test Coverage (#103) +- Add Mail Configuration (#100) + ## 2.4.0 (released 2015-05-10) - Add post revisions to config (#98) From ed22552c2b8dc8af7f3836b1d19ac47d803d5aff Mon Sep 17 00:00:00 2001 From: Vincent Klaiber Date: Thu, 21 May 2015 12:57:22 +0200 Subject: [PATCH 4/4] Use stable version --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 66194398..5fc707e4 100644 --- a/composer.json +++ b/composer.json @@ -10,7 +10,7 @@ } ], "require": { - "wordplate/framework": "2.5.*@dev", + "wordplate/framework": "2.5.*", "wpackagist-plugin/advanced-custom-fields": "~4.0", "wpackagist-plugin/tiny-compress-images": "~1.0", "wpackagist-plugin/wordpress-importer": "~0.6",