<commit_before>Bootstrap CMS
=============


[![Build Status](https://img.shields.io/travis/GrahamCampbell/Bootstrap-CMS/master.svg)](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS)
[![Coverage Status](https://img.shields.io/coveralls/GrahamCampbell/Bootstrap-CMS/master.svg)](https://coveralls.io/r/GrahamCampbell/Bootstrap-CMS)
[![Software License](https://img.shields.io/badge/license-AGPL%203.0-brightgreen.svg)](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/LICENSE.md)
[![Latest Version](https://img.shields.io/github/release/GrahamCampbell/Bootstrap-CMS.svg)](https://github.com/GrahamCampbell/Bootstrap-CMS/releases)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS/badges/quality-score.png?s=df19b33e11d486109decb5c9c78b1d7d049ddde6)](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/9eb79f92-a80a-46dc-9a3d-726c0ecc4162/mini.png)](https://insight.sensiolabs.com/projects/9eb79f92-a80a-46dc-9a3d-726c0ecc4162)


## WARNING

#### This is the incomplete [V0.7](https://github.com/GrahamCampbell/Bootstrap-CMS/issues?milestone=8) and is subject to extreme change and refactoring. Please use [V0.6](https://github.com/GrahamCampbell/Bootstrap-CMS/releases/tag/v0.6.0-alpha) instead of cloning from the master branch.


## THIS ALPHA RELEASE IS FOR TESTING ONLY

#### I'd appreciate it if you'd leave my name in the footer unless you have changed my source significantly. If you do feel you have changed it significantly, I'd still appreciate some kind of link back, and remember that attribution is still required as stated in the license. Thank you, and enjoy!


## What Is Bootstrap CMS?

Bootstrap CMS is a PHP CMS powered by [Laravel 4.1](http://laravel.com) and [Sentry 2.1](https://cartalyst.com/manual/sentry).

* Bootstrap CMS was created by, and is maintained by [<NAME>](https://github.com/GrahamCampbell).
* Bootstrap CMS relies on many of my packages including [Laravel Core](https://github.com/GrahamCampbell/Laravel-Core) and [Laravel Queuing](https://github.com/GrahamCampbell/Laravel-Queuing).
* Bootstrap CMS uses [Travis CI](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS) with [Coveralls](https://coveralls.io/r/GrahamCampbell/Bootstrap-CMS) to check everything is working.
* Bootstrap CMS uses [Scrutinizer CI](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS) and [SensioLabsInsight](https://insight.sensiolabs.com/projects/9eb79f92-a80a-46dc-9a3d-726c0ecc4162) to run additional checks.
* Bootstrap CMS uses [Composer](https://getcomposer.org) to load and manage dependencies.
* Bootstrap CMS provides a [change log](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/CHANGELOG.md), [releases](https://github.com/GrahamCampbell/Bootstrap-CMS/releases), and [api docs](http://grahamcampbell.github.io/Bootstrap-CMS).
* Bootstrap CMS is licensed under the GNU AGPLv3, available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/LICENSE.md).
* Licenses for included components are available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/tree/master/licenses), excluding [Composer](https://getcomposer.org) installed components.


## System Requirements

Bootstrap CMS was designed to run on a Linux machine with PHP 5.5 and MySQL 5.5.

* PHP 5.4.7+ or HHVM 3.0+.
* You will need [Composer](https://getcomposer.org) installed to load the dependencies of Bootstrap CMS.
* You will need to configure the site in the app/config folder before production.
* Some features require a cache server like [Redis](http://redis.io) and a queuing server like [Beanstalkd](http://kr.github.io/beanstalkd).


## Installation

Please check the system requirements before installing Bootstrap CMS.

1. You may install by cloning from github, or via composer.
  * Github: `git clone <EMAIL>:GrahamCampbell/Bootstrap-CMS.git`
  * Composer: `composer create-project graham-campbell/bootstrap-cms --prefer-dist -s dev`
2. See the [Laravel Queuing](https://github.com/GrahamCampbell/Laravel-Queuing) readme for extra requirements before continuing.
3. From a command line open in the folder, run `composer install`.
4. Enter your database details into `app/config/databse.php`.
5. Run `php artisan app:install` to setup and seed your database.
6. You will need to enter your mail server details into `app/config/mail.php`.
  * You can disable verification emails on registration in `app/config/cms.php`
  * Mail is still required for other functions like password resets
  * I'd recommend [queuing](#setting-up-queing) email sending for greater performance (see below)
7. Finally, setup an [Apache VirtualHost](http://httpd.apache.org/docs/current/vhosts/examples.html) to point to the "public" folder.
  * For development, you can simply run `php artisan serve`
8. Additionally, you may to setup some of Bootstrap CMS's other features (see below).
  * Some things, like [caching](#setting-up-caching) and [queuing](#setting-up-queing), are disabled out of the box
  * This is to allow Bootstrap CMS to work with minimal setup
  * Please note that queuing is required in order to use the cron functionality which can do things like notify users of upcoming events, or send out weekly activity digests
  * Also note, without caching asset generation will cause page load delay - to reduce this, I have turned off minification in `app/config/packages/lightgear/asset/config.php` by default


## Setting Up Queuing

Bootstrap CMS provides queuing functionality, and when enabled, requires 3 separate queues.

  * One queue (the mail queue) will be used for sending emails
  * One queue (the cron queue) will be used for all cron jobs
  * One queue (the default queue) will be used for all other jobs
  * These queues must be separate to avoid unexpected functionality

Note that `beanstalkd` requires a local server, while `sqs` and `iron` are cloud based.
Also note that `sqs` support is not 100% complete and is mainly untested.<commit_msg>Fixed bad docs<commit_after>Bootstrap CMS
=============


[![Build Status](https://img.shields.io/travis/GrahamCampbell/Bootstrap-CMS/master.svg)](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS)
[![Coverage Status](https://img.shields.io/coveralls/GrahamCampbell/Bootstrap-CMS/master.svg)](https://coveralls.io/r/GrahamCampbell/Bootstrap-CMS)
[![Software License](https://img.shields.io/badge/license-AGPL%203.0-brightgreen.svg)](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/LICENSE.md)
[![Latest Version](https://img.shields.io/github/release/GrahamCampbell/Bootstrap-CMS.svg)](https://github.com/GrahamCampbell/Bootstrap-CMS/releases)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS/badges/quality-score.png?s=df19b33e11d486109decb5c9c78b1d7d049ddde6)](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/9eb79f92-a80a-46dc-9a3d-726c0ecc4162/mini.png)](https://insight.sensiolabs.com/projects/9eb79f92-a80a-46dc-9a3d-726c0ecc4162)


## WARNING

#### This is the incomplete [V0.7](https://github.com/GrahamCampbell/Bootstrap-CMS/issues?milestone=8) and is subject to extreme change and refactoring. Please use [V0.6](https://github.com/GrahamCampbell/Bootstrap-CMS/releases/tag/v0.6.0-alpha) instead of cloning from the master branch.


## THIS ALPHA RELEASE IS FOR TESTING ONLY

#### I'd appreciate it if you'd leave my name in the footer unless you have changed my source significantly. If you do feel you have changed it significantly, I'd still appreciate some kind of link back, and remember that attribution is still required as stated in the license. Thank you, and enjoy!


## What Is Bootstrap CMS?

Bootstrap CMS is a PHP CMS powered by [Laravel 4.1](http://laravel.com) and [Sentry 2.1](https://cartalyst.com/manual/sentry).

* Bootstrap CMS was created by, and is maintained by [<NAME>](https://github.com/GrahamCampbell).
* Bootstrap CMS relies on many of my packages including [Laravel Core](https://github.com/GrahamCampbell/Laravel-Core) and [Laravel Queuing](https://github.com/GrahamCampbell/Laravel-Queuing).
* Bootstrap CMS uses [Travis CI](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS) with [Coveralls](https://coveralls.io/r/GrahamCampbell/Bootstrap-CMS) to check everything is working.
* Bootstrap CMS uses [Scrutinizer CI](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS) and [SensioLabsInsight](https://insight.sensiolabs.com/projects/9eb79f92-a80a-46dc-9a3d-726c0ecc4162) to run additional checks.
* Bootstrap CMS uses [Composer](https://getcomposer.org) to load and manage dependencies.
* Bootstrap CMS provides a [change log](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/CHANGELOG.md), [releases](https://github.com/GrahamCampbell/Bootstrap-CMS/releases), and [api docs](http://grahamcampbell.github.io/Bootstrap-CMS).
* Bootstrap CMS is licensed under the GNU AGPLv3, available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/LICENSE.md).
* Licenses for included components are available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/tree/master/licenses), excluding [Composer](https://getcomposer.org) installed components.


## System Requirements

Bootstrap CMS was designed to run on a Linux machine with PHP 5.5 and MySQL 5.5.

* PHP 5.4.7+ or HHVM 3.0+.
* You will need [Composer](https://getcomposer.org) installed to load the dependencies of Bootstrap CMS.
* You will need to configure the site in the app/config folder before production.
* Some features require a cache server like [Redis](http://redis.io) and a queuing server like [Beanstalkd](http://kr.github.io/beanstalkd).


## Installation

Please check the system requirements before installing Bootstrap CMS.

1. You may install by cloning from github, or via composer.
  * Github: `git clone <EMAIL>:GrahamCampbell/Bootstrap-CMS.git`
  * Composer: `composer create-project graham-campbell/bootstrap-cms --prefer-dist -s dev`
2. See the [Laravel Queuing](https://github.com/GrahamCampbell/Laravel-Queuing) readme for extra requirements before continuing.
3. From a command line open in the folder, run `composer install`.
4. Enter your database details into `app/config/databse.php`.
5. Run `php artisan app:install` to setup and seed your database.
6. You will need to enter your mail server details into `app/config/mail.php`.
  * You can disable verification emails in `app/config/packages/graham-campbell/navigation/config.php`
  * Mail is still required for other functions like password resets
  * I'd recommend [queuing](#setting-up-queing) email sending for greater performance (see below)
7. Finally, setup an [Apache VirtualHost](http://httpd.apache.org/docs/current/vhosts/examples.html) to point to the "public" folder.
  * For development, you can simply run `php artisan serve`
8. Additionally, you may to setup some of Bootstrap CMS's other features (see below).
  * Some things, like [caching](#setting-up-caching) and [queuing](#setting-up-queing), are disabled out of the box
  * This is to allow Bootstrap CMS to work with minimal setup
  * Please note that queuing is required in order to use the cron functionality which can do things like notify users of upcoming events, or send out weekly activity digests
  * Also note, without caching asset generation will cause page load delay - to reduce this, I have turned off minification in `app/config/packages/lightgear/asset/config.php` by default


## Setting Up Queuing

Bootstrap CMS provides queuing functionality, and when enabled, requires 3 separate queues.

  * One queue (the mail queue) will be used for sending emails
  * One queue (the cron queue) will be used for all cron jobs
  * One queue (the default queue) will be used for all other jobs
  * These queues must be separate to avoid unexpected functionality

Note that `beanstalkd` requires a local server, while `sqs` and `iron` are cloud based.
Also note that `sqs` support is not 100% complete and is mainly untested.
{'fraction_non_alphanumeric': 0.1136175153425112, 'fraction_numerical': 0.019406203350472714, 'mean_word_length': 4.996519144704127, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 60, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3885809', 'n_tokens_mistral': 3978, 'n_tokens_neox': 3625, 'n_words': 1143}