Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* master: add content-variables to phing install; disable plugin testing on travis for now updates readme and documentation cleans up /index.php inject all settings in Twig template renderer class via constructor update version strings removes unused Icon.png contributors to composer fixes some type hinting and comments, whitespaces
- Loading branch information
Showing
19 changed files
with
133 additions
and
303 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,7 +14,6 @@ env: | |
matrix: | ||
include: | ||
- php: 7.1 | ||
env: PLUGINS=1 | ||
- php: 7.2 | ||
env: PHPCS=1 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,103 +1,77 @@ | ||
PhileCMS | ||
======== | ||
# PhileCMS | ||
|
||
[![Software License](https://img.shields.io/packagist/l/phile-cms/phile.svg)](https://github.com/PhileCMS/Phile/blob/master/LICENSE) | ||
[![Packagist Version](https://img.shields.io/packagist/v/phile-cms/phile.svg)](https://packagist.org/packages/phile-cms/phile) | ||
[![Build Status](https://travis-ci.org/PhileCMS/Phile.svg?branch=master)](https://travis-ci.org/PhileCMS/Phile) | ||
[![Code Quality](https://img.shields.io/scrutinizer/g/PhileCMS/Phile.svg)](https://scrutinizer-ci.com/g/PhileCMS/Phile/?branch=master) | ||
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/PhileCMS/Phile.svg)](https://scrutinizer-ci.com/g/PhileCMS/Phile/?branch=master) | ||
|
||
A Markdown file-based CMS written in PHP. | ||
|
||
A Markdown file-based CMS. | ||
|
||
[Check out the starter video](http://www.youtube.com/watch?v=8GLMe371RuI) or [read the wiki for in-depth documentation](https://github.com/PhileCMS/Phile/wiki/_pages). | ||
|
||
## Gitter Developer & Support-System | ||
|
||
[![Gitter chat](https://badges.gitter.im/PhileCMS/Phile.png)](https://gitter.im/PhileCMS/Phile) | ||
[Check out the starter video](http://www.youtube.com/watch?v=8GLMe371RuI) or [read the wiki for in-depth documentation](https://philecms.github.io/wiki/). | ||
|
||
## Why use PhileCMS? | ||
|
||
The desire to fork the project from Pico, came when a few community members wanted to contribute more and increase the rate of development progress. | ||
|
||
Here is a small list of differences in design from typical flat-file CMSs: | ||
Phile was forked from Pico when a few community members wanted to contribute more and increase the rate of development. Here is a small list of differences: | ||
|
||
* OOP based (classes) | ||
* [Events system](https://github.com/PhileCMS/Phile/wiki/%5BDEVELOPER%5D-Event-System) | ||
* [Uses Composer](https://github.com/PhileCMS/Phile/blob/master/composer.json) | ||
* Overload core modules (plugins) | ||
* Object Oriented Design (classes) | ||
* Events system | ||
* Replacable core modules (plugins) | ||
* Parser (default: [Markdown](https://github.com/michelf/php-markdown)) | ||
* Template Engine (default: [Twig](http://twig.sensiolabs.org/)) | ||
* Cache (default: [phpFastCache](https://github.com/khoaofgod/phpfastcache)) | ||
* Error handler (default: system handler) | ||
* Meta parser (default: system parser) | ||
* Simple Data Persistence (default: system data storage) | ||
* Error handler (default: Phile handler) | ||
* Meta parser (default: Phile parser) | ||
* Simple Data Persistence (default: Phile file-based) | ||
* Per-Plugin `config.php` files | ||
* *Namespaced plugins* so classes can have the same name | ||
* [PSR-0 Compliant](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) | ||
* Namespaced plugins so classes can have the same name | ||
* PSR-0, PSR-1/2, PSR-7/15 | ||
|
||
## Installation | ||
## Quick Start | ||
|
||
##### Requirements | ||
Requirements: | ||
|
||
* PHP `>=5.6.0` | ||
* PHP 7.1.0+ | ||
* a web-server | ||
|
||
##### Quick Start | ||
Download the release from <https://philecms.github.io/>, copy the files to your web-server and open the root directory in the browser. | ||
|
||
You can install the latest version either by downloading it from <https://github.com/PhileCMS/Phile/releases> or use composer: | ||
Or use composer and run it locally: | ||
|
||
```shell | ||
composer create-project --no-dev phile-cms/phile | ||
composer create-project --no-dev phile-cms/phile; | ||
cd Phile; | ||
php -S localhost:8080; | ||
``` | ||
|
||
Copy it to your server web root. Open the root of PhileCMS on you web server. If you are using the default MAMP install, that would be [http://localhost:8888/Phile](http://localhost:8888/Phile). Using WAMP, [http://localhost/Phile](http://localhost/Phile). If you are using something else, you probably know how to run a typical PHP site. | ||
|
||
On first run you will hit a setup page. **Follow the instructions on the [setup page](https://github.com/PhileCMS/Phile/blob/master/plugins/phile/setupCheck/setup.md) to complete the installation**. | ||
|
||
[For detailed instructions please see the Installation wiki page](https://github.com/PhileCMS/Phile/wiki/%5BHOW-TO%5D-Installation). | ||
On a fresh installation you will see a page with a setup instructions. Follow them. For detailed instructions please see the [installation help](https://philecms.github.io/wiki/%5BHOW-TO%5D-Installation.html). | ||
|
||
## Plugins | ||
|
||
Phile can be extended with a wide variety of plugins. You can also overwrite the default plugins in order to add extra functionality, speed, or features. | ||
Phile can be extended with [a wide variety of plugins](https://philecms.github.io/wiki/%5BCOMMUNITY%5D-Plugins.html). | ||
|
||
Help make Phile better by checking out the GitHub repository and submitting pull requests. | ||
Generally a plugin can always be installed manually: clone or download the plugin into `plugins/{vendor}/{pluginName}` folder. **Example**: [phileRss](https://github.com/PhileCMS/phileRSSFeed/) would be installed into `plugins/phile/rssFeed`. | ||
|
||
##### With composer | ||
|
||
To install via composer, you would run: | ||
Many plugins also allow composer installation: | ||
|
||
```php | ||
composer require phile/rss-feed:dev-master | ||
``` | ||
|
||
##### With git | ||
|
||
While sitting in your root PhileCMS folder, you can run: | ||
|
||
```shell | ||
git clone https://github.com/PhileCMS/phileRSSFeed plugins/phile/rssFeed | ||
composer require phile/rss-feed | ||
``` | ||
|
||
##### You've downloaded the .zip | ||
|
||
You can clone or download the plugin into the `plugins/{namespace}/{pluginClassName}` folder. **Example**: [phileAdmin](https://github.com/james2doyle/phileAdmin) would be installed into `plugins/phile/adminPanel`. | ||
Always check the plugin readme for specialised installation instruction. | ||
|
||
## Getting Help | ||
|
||
You can [read the wiki](https://github.com/PhileCMS/Phile/wiki) if you are looking for examples and [read the intro-docs](http://philecms.com/docs.html) for more development information. If you are looking for some general help and have some questions, please post in the [Google Plus Community](https://plus.google.com/u/0/communities/105363272048954062353 "PhileCMS Community"). | ||
[![Gitter chat](https://badges.gitter.im/PhileCMS/Phile.png)](https://gitter.im/PhileCMS/Phile) | ||
|
||
You can [read the wiki](https://philecms.github.io/wiki/) if you are looking for examples more development information. | ||
|
||
If you *find a bug* please report it on the [issues page](https://github.com/PhileCMS/Phile/issues), but remember to include a bunch of details and also what someone can do to re-create the issue. | ||
|
||
Issues with plugins should be reported **on the offending plugins homepage** this goes for themes as well. | ||
Issues with plugins should be reported *on the offending plugins homepage* this goes for themes as well. | ||
|
||
## Contributing | ||
|
||
Help make PhileCMS better by checking out the GitHub repository and submitting pull requests. | ||
See [developer guildlines](https://github.com/PhileCMS/Phile/wiki/%5BDEVELOPER%5D-Developer-Guidelines) for more information. | ||
|
||
If you create a plugin please add it to the [Plugin Wiki](https://github.com/PhileCMS/Phile/wiki/%5BCOMMUNITY%5D-Plugins). | ||
|
||
### The Authors of PhileCMS | ||
See [developer guildlines](https://philecms.github.io/wiki/%5BDEVELOPER%5D-Developer-Guidelines.html) for more information. | ||
|
||
* [James Doyle](https://github.com/james2doyle) - great ideas, developed many plugins and worked on the core | ||
* [Frank Nägler](https://github.com/NeoBlack) - refactoring of the core and introducing OOP concepts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.