You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 18, 2018. It is now read-only.
The first command is only necessary the first time. If you have issues merging, you will need to get a merge tool such as [P4Merge](http://perforce.com/product/components/perforce_visual_merge_and_diff_tools).
11
+
12
+
You can then update the branch:
13
+
14
+
git pull --rebase upstream develop
15
+
git push --force origin <branch_name>
16
+
17
+
Once it is set up, run `git mergetool`. Once all conflicts are fixed, run `git rebase --continue`, and `git push --force origin <branch_name>`.
18
+
19
+
20
+
## Pull Requests
21
+
22
+
Please submit pull requests against the develop branch.
23
+
24
+
* Any pull requests made against the master branch will be closed immediately.
25
+
* If you plan to fix a bug, please create a branch called `fix-`, followed by an appropriate name.
26
+
* If you plan to add a feature, please create a branch called `feature-`, followed by an appropriate name.
27
+
* Please follow the [PSR-2 Coding Style](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and [PHP-FIG Naming Conventions](https://github.com/php-fig/fig-standards/blob/master/bylaws/002-psr-naming-conventions.md).
#### 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!
15
+
#### 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!
19
16
20
17
21
18
## What Is Bootstrap CMS?
22
19
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).
20
+
Bootstrap CMS is a PHP CMS powered by [Laravel 4.0](http://laravel.com) with [CMS Core](https://github.com/GrahamCampbell/CMS-Core) and [Sentry 2](https://cartalyst.com/manual/sentry).
24
21
25
22
* Bootstrap CMS was created by, and is maintained by [Graham Campbell](https://github.com/GrahamCampbell).
23
+
* Bootstrap CMS relies on my [CMS Core](https://github.com/GrahamCampbell/CMS-Core) package.
26
24
* Bootstrap CMS uses [Travis CI](https://travis-ci.org/GrahamCampbell/Bootstrap-CMS) to run tests to check if it's working as it should.
27
-
* Bootstrap CMS uses [Scrutinizer CI](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS) to run additional tests and checks.
25
+
* Bootstrap CMS uses [Scrutinizer CI](https://scrutinizer-ci.com/g/GrahamCampbell/Bootstrap-CMS)and [Coveralls](https://coveralls.io/r/GrahamCampbell/Bootstrap-CMS)to run additional tests and checks.
28
26
* Bootstrap CMS uses [Composer](https://getcomposer.org) to load and manage dependencies.
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).
30
-
* Bootstrap CMS is licensed under the GNU AGPLv3, available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/master/LICENSE.md).
27
+
* Bootstrap CMS provides a [change log](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/develop/CHANGELOG.md), [releases](https://github.com/GrahamCampbell/Bootstrap-CMS/releases), and a [wiki](https://github.com/GrahamCampbell/Bootstrap-CMS/wiki).
28
+
* Bootstrap CMS is licensed under the GNU AGPLv3, available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/blob/develop/LICENSE.md).
29
+
* Licenses for included components are available [here](https://github.com/GrahamCampbell/Bootstrap-CMS/tree/develop/licenses), excluding [Composer](https://getcomposer.org) installed components.
31
30
32
31
33
32
## What Does Testing Release Mean?
@@ -37,6 +36,7 @@ Basically, expect no support what so ever. This includes, but is not exclusive t
37
36
* No support or help will be given during installation or updating.
38
37
* No database migration support between updates
39
38
* Updates may not be backwards compatible
39
+
* From V0.4, a migration path will always be provided between tagged releases
40
40
* Some of the config may be for features that don't exist yet.
41
41
* Some config may even brake the entire site
42
42
* Just remember, this software comes WITHOUT ANY WARRANTY
@@ -47,9 +47,9 @@ Basically, expect no support what so ever. This includes, but is not exclusive t
47
47
48
48
## System Requirements
49
49
50
-
Bootstrap CMS was designed to run on a Linux machine with PHP 5.4 and MySQL 5.5.
50
+
Bootstrap CMS was designed to run on a Linux machine with PHP 5.5 and MySQL 5.5.
51
51
52
-
* PHP 5.4.7+ or PHP 5.5+ is required.
52
+
* PHP 5.4.7+ or PHP 5.5+ is required.
53
53
* MySQL 5.1+, 5.5+, or 5.6+ is required. MySQL 5.7+ may work, but is untested.
54
54
* You will need [Composer](https://getcomposer.org) installed to load the dependencies of Bootstrap CMS.
55
55
* You will need to configure the site in the app/config folder before production.
@@ -62,7 +62,7 @@ Please check the system requirements before installing Bootstrap CMS.
62
62
63
63
1. You may install by cloning from github, or via composer.
2. From a command line open in the folder, run `composer install`.
67
67
3. Enter your database details into `app/config/databse.php`.
68
68
4. Run `php artisan app:install` to setup and seed your database.
@@ -75,21 +75,30 @@ Please check the system requirements before installing Bootstrap CMS.
75
75
7. Additionally, you may to setup some of Bootstrap CMS's other features (see below).
76
76
* Some things, like [caching](#setting-up-caching) and [queuing](#setting-up-queing), are disabled out of the box
77
77
* This is to allow Bootstrap CMS to work with minimal setup
78
+
* 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
78
79
79
80
80
81
## Setting Up Queuing
81
82
83
+
Bootstrap CMS provides queuing functionality, and when enabled, requires 3 separate queues.
84
+
* One queue (the mail queue) will be used for sending emails
85
+
* One queue (the cron queue) will be used for all cron jobs
86
+
* One queue (the default queue) will be used for all other jobs
87
+
* These queues must be separate to avoid unexpected functionality
88
+
82
89
Note that `beanstalkd` requires a local server, while `sqs` and `iron` are cloud based.
90
+
Also note that `sqs` support is not 100% complete and is mainly untested.
83
91
84
92
1. Choose your poison - I'd recommend [IronMQ](http://www.iron.io/mq).
85
93
2. Enter your queuing server details into `app/config/queue.php`.
86
94
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`.
95
+
4. For [IronMQ](http://www.iron.io/mq), you can run the command `php artisan queue:iron`.
88
96
5. You can find out more about queuing by heading over to the [Laravel Docs](http://laravel.com/docs/queues).
89
97
90
98
91
99
## Setting Up Caching
92
100
101
+
Bootstrap CMS provides caching functionality, and when enabled, requires a caching server.
93
102
Note that caching will not work with Laravel's `file` or `database` cache drivers.
94
103
95
104
1. Choose your poison - I'd recommend [Redis](http://redis.io).
Bootstrap CMS also ships with 13 themesfrom [Bootswatch](http://bootswatch.com/2).
120
+
Bootstrap CMS also ships with 14 themes, 12 from [Bootswatch](http://bootswatch.com).
112
121
113
122
1. You can set your theme in `app/config/theme.php`.
114
123
2. You can also set your nav bar style in `app/config/theme.php`.
115
124
3. After making theme changes, you will have to run `php artisan app:update`.
116
125
117
126
127
+
## Setting Up Plugins
128
+
129
+
Bootstrap CMS supports plugins through [CMS Core](https://github.com/GrahamCampbell/CMS-Core).
130
+
Note that Bootstrap CMS already ships with the [CMS LogViewer](https://github.com/GrahamCampbell/CMS-LogViewer) plugin.
131
+
132
+
1. Add the plugin's package name to your `composer.json`.
133
+
2. Add the service provider for the plugin in`app/config/cms.php`.
134
+
3. Run `composer update` then `php artisan app:update` to install the plugin.
135
+
136
+
137
+
## Usage
138
+
139
+
There is currently no usage documentation besides the [API Documentation](http://grahamcampbell.github.io/Bootstrap-CMS) for Bootstrap CMS.
140
+
141
+
118
142
## Updating Your Fork
119
143
120
144
The latest and greatest source can be found on [GitHub](https://github.com/GrahamCampbell/Bootstrap-CMS).
@@ -128,19 +152,38 @@ The first command is only necessary the first time. If you have issues merging,
128
152
129
153
You can then update the branch:
130
154
131
-
git pull --rebase upstream master
155
+
git pull --rebase upstream develop
132
156
git push --force origin <branch_name>
133
157
134
158
Once it is set up, run `git mergetool`. Once all conflicts are fixed, run `git rebase --continue`, and `git push --force origin <branch_name>`.
135
159
136
160
161
+
## Pull Requests
162
+
163
+
Please submit pull requests against the develop branch.
164
+
165
+
* Any pull requests made against the master branch will be closed immediately.
166
+
* If you plan to fix a bug, please create a branch called `fix-`, followed by an appropriate name.
167
+
* If you plan to add a feature, please create a branch called `feature-`, followed by an appropriate name.
168
+
* Please follow the [PSR-2 Coding Style](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and [PHP-FIG Naming Conventions](https://github.com/php-fig/fig-standards/blob/master/bylaws/002-psr-naming-conventions.md).
169
+
170
+
137
171
## License
138
172
139
-
Bootstrap CMS - A CMS Powered By Laravel 4
173
+
GNU AFFERO GENERAL PUBLIC LICENSE
174
+
175
+
Bootstrap CMS Is A PHP CMS Powered By Laravel 4.0 With CMS Core And Sentry 2
140
176
Copyright (C) 2013 Graham Campbell
141
177
142
-
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
178
+
This program is free software: you can redistribute it and/or modify
179
+
it under the terms of the GNU Affero General Public License as published by
180
+
the Free Software Foundation, either version 3 of the License, or
181
+
(at your option) any later version.
182
+
183
+
This program is distributed in the hope that it will be useful,
184
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
185
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
186
+
GNU Affero General Public License for more details.
143
187
144
-
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
145
-
146
-
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.
188
+
You should have received a copy of the GNU Affero General Public License
189
+
along with this program. If not, see <http://www.gnu.org/licenses/>.
0 commit comments