Skip to content

Latest commit

 

History

History
108 lines (67 loc) · 5.12 KB

README.md

File metadata and controls

108 lines (67 loc) · 5.12 KB
Raw

PhileCMS

Software License Packagist Version Build Status Code Quality Code Coverage

A Markdown file-based CMS.

Check out the starter video or read the wiki for in-depth documentation.

Gitter Developer & Support-System

Gitter chat

waffle.io board

Stories in Ready

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:

  • OOP based (classes)
  • Events system
  • Uses Composer
  • Overload core modules (plugins)
    • Parser (default: Markdown)
    • Template Engine (default: Twig)
    • Cache (default: phpFastCache)
    • Error handler (default: system handler)
    • Meta parser (default: system parser)
    • Simple Data Persistence (default: system data storage)
  • Per-Plugin config.php files
  • Namespaced plugins so classes can have the same name
  • PSR-0 Compliant

Installation

Requirements
  • PHP >=5.6.0
  • Apache with mod_rewrite enabled
Quick Start

You can install the latest version either by downloading it from https://github.com/PhileCMS/Phile/releases or use composer:

composer create-project --no-dev phile-cms/phile

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. Using WAMP, 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 to complete the installation.

For detailed instructions please see the Installation wiki page.

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.

Help make Phile better by checking out the GitHub repository and submitting pull requests.

With composer

To install via composer, you would run:

composer require phile/rss-feed:dev-master
With git

While sitting in your root PhileCMS folder, you can run:

git clone https://github.com/PhileCMS/phileRSSFeed plugins/phile/rssFeed
You've downloaded the .zip

You can clone or download the plugin into the plugins/{namespace}/{pluginClassName} folder. Example: phileAdmin would be installed into plugins/phile/adminPanel.

Getting Help

You can read the wiki if you are looking for examples and read the intro-docs for more development information. If you are looking for some general help and have some questions, please post in the Google Plus Community.

If you find a bug please report it on the issues page, 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.

Contributing

Help make PhileCMS better by checking out the GitHub repository and submitting pull requests. See developer guildlines for more information.

If you create a plugin please add it to the Plugin Wiki.

The Authors of PhileCMS

  • James Doyle - great ideas, developed many plugins and worked on the core
  • Frank Nägler - refactoring of the core and introducing OOP concepts