|
1 | | -Bootstrap-CMS |
| 1 | +Bootstrap CMS |
2 | 2 | ============= |
3 | 3 |
|
4 | 4 |
|
5 | | -[](https://packagist.org/packages/graham-campbell/bootstrap-cms) |
| 5 | +[](https://bitdeli.com/free "Bitdeli Badge") |
6 | 6 | [](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS) |
7 | | -[](https://packagist.org/packages/graham-campbell/bootstrap-cms) |
8 | | -[](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS) |
| 7 | +[](https://packagist.org/packages/graham-campbell/bootstrap-cms) |
9 | 8 | [](https://packagist.org/packages/graham-campbell/bootstrap-cms) |
10 | | -[](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS/) |
| 9 | +[](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS) |
11 | 10 | [](http://stillmaintained.com/GrahamCampbell/Bootstrap-CMS) |
12 | 11 |
|
13 | 12 |
|
14 | | -[](https://bitdeli.com/free "Bitdeli Badge") |
15 | | - |
16 | | - |
17 | 13 | Copyright © [Graham Campbell](https://github.com/GrahamCampbell) 2013 |
18 | 14 |
|
19 | 15 |
|
20 | 16 | ## THIS ALPHA RELEASE IS FOR TESTING ONLY |
21 | 17 |
|
| 18 | +#### I'd appriciate it if you'd leave my name in the footer unless you have changed my source significatly. If you do feel you have changed it significantly, i'd still appreciate some kind of link back. Thank you, and enjoy! |
| 19 | + |
22 | 20 |
|
23 | 21 | ## What Is Bootstrap CMS? |
24 | 22 |
|
25 | 23 | Bootstrap CMS is a PHP CMS powered by [Laravel 4.0](http://laravel.com) with [Sentry 2.0](http://docs.cartalyst.com/sentry-2). |
26 | 24 |
|
27 | 25 | * Bootstrap CMS was created by, and is maintained by [Graham Campbell](https://github.com/GrahamCampbell). |
28 | 26 | * Bootstrap CMS uses [Travis CI](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS) to run tests to check if it's working as it should. |
29 | | -* Bootstrap CMS uses [Scrutinizer CI](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS) to run additional tests and checks. |
| 27 | +* Bootstrap CMS uses [Scrutinizer CI](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS) to run additional tests and checks. |
30 | 28 | * Bootstrap CMS uses [Composer](https://getcomposer.org) to load and manage dependencies. |
31 | 29 | * 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 a [wiki](https://github.com/GrahamCampbell/Bootstrap-CMS/wiki). |
32 | 30 | * Bootstrap CMS is licensed under the GNU AGPLv3, available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/LICENSE.md). |
@@ -63,18 +61,58 @@ Bootstrap CMS was designed to run on a Linux machine with PHP 5.4 and MySQL 5.5. |
63 | 61 | Please check the system requirements before installing Bootstrap CMS. |
64 | 62 |
|
65 | 63 | 1. You may install by cloning from github, or via composer. |
66 | | - * Github: "git clone [email protected]:GrahamCampbell/Bootstrap-CMS.git" |
67 | | - * Composer: "composer create-project graham-campbell/bootstrap-cms cms dev-master" |
68 | | - * You can swap out "dev-master" for "dev-develop", or any release tag. |
69 | | -2. From a command line open in the folder, run "composer install". |
70 | | -3. Navigate to app/config, and adjust the config accordingly. |
71 | | - * If you don't want Boostrap CMS to send emails, you can disable that in cms.php |
72 | | - * If you don't have a cache server like [Redis](http://redis.io), disable caching in cms.php |
73 | | - * If you don't have a queuing server like [Beanstalkd](http://kr.github.io/beanstalkd), set queue.php to use "sync" |
74 | | -4. You can run "php artisan app:install" to setup and seed your database. |
75 | | - * Make sure you setup your database config in database.php. |
76 | | -5. Finally, setup an [Apache VirtualHost](http://httpd.apache.org/docs/current/vhosts/examples.html) to point to the "public" folder. |
77 | | - * For development, you can simply run "php artisan serve" |
| 64 | + * Github: `git clone [email protected]:GrahamCampbell/Bootstrap-CMS.git` |
| 65 | + * Composer: `composer create-project graham-campbell/bootstrap-cms --prefer-dist` |
| 66 | +2. From a command line open in the folder, run `composer install`. |
| 67 | +3. Enter your database details into `app/config/databse.php`. |
| 68 | +4. Run `php artisan app:install` to setup and seed your database. |
| 69 | +5. You will need to enter your mail server details into `app/config/mail.php`. |
| 70 | + * You can disable verification emails on registration in `app/config/cms.php` |
| 71 | + * Mail is still required for other functions like password resets |
| 72 | + * I'd recommend [queuing](#setting-up-queing) email sending for greater performance (see below) |
| 73 | +6. Finally, setup an [Apache VirtualHost](http://httpd.apache.org/docs/current/vhosts/examples.html) to point to the "public" folder. |
| 74 | + * For development, you can simply run `php artisan serve` |
| 75 | +7. Additionally, you may to setup some of Bootstrap CMS's other features (see below). |
| 76 | + * Some things, like [caching](#setting-up-caching) and [queuing](#setting-up-queing), are disabled out of the box |
| 77 | + * This is to allow Bootstrap CMS to work with minimal setup |
| 78 | + |
| 79 | + |
| 80 | +## Setting Up Queuing |
| 81 | + |
| 82 | +Note that `beanstalkd` requires a local server, while `sqs` and `iron` are cloud based. |
| 83 | + |
| 84 | +1. Choose your poison - I'd recommend [IronMQ](http://www.iron.io/mq). |
| 85 | +2. Enter your queuing server details into `app/config/queue.php`. |
| 86 | +3. You can also set a separate mail queue in `app/config/mail.php`. |
| 87 | +4. For [IronMQ](http://www.iron.io/mq), the queue subscription path is `/queue/receive`. |
| 88 | +5. You can find out more about queuing by heading over to the [Laravel Docs](http://laravel.com/docs/queues). |
| 89 | + |
| 90 | + |
| 91 | +## Setting Up Caching |
| 92 | + |
| 93 | +Note that caching will not work with Laravel's `file` or `database` cache drivers. |
| 94 | + |
| 95 | +1. Choose your poison - I'd recommend [Redis](http://redis.io). |
| 96 | +2. Enter your cache server details into `app/config/cache.php`. |
| 97 | +3. Enable Bootstrap CMS's caching in `app/config/cms.php`. |
| 98 | + |
| 99 | + |
| 100 | +## Setting Up Analytics |
| 101 | + |
| 102 | +Bootstrap CMS natively supports [Google Analytics](http://www.google.com/analytics) (other services to come later). |
| 103 | + |
| 104 | +1. Setup a web property on [Google Analytics](http://www.google.com/analytics). |
| 105 | +2. Enter your tracking id into `app/config/analytics.php`. |
| 106 | +3. Enable Google Analytics in `app/config/analytics.php`. |
| 107 | + |
| 108 | + |
| 109 | +## Setting Up Themes |
| 110 | + |
| 111 | +Bootstrap CMS also ships with 13 themes from [Bootswatch](http://bootswatch.com/2). |
| 112 | + |
| 113 | +1. You can set your theme in `app/config/theme.php`. |
| 114 | +2. You can also set your nav bar style in `app/config/theme.php`. |
| 115 | +3. After making theme changes, you will have to run `php artisan app:update`. |
78 | 116 |
|
79 | 117 |
|
80 | 118 | ## Updating Your Fork |
|
0 commit comments