aheinze/cockpit

An api-driven CMS without forcing you to make compromises in how you implement your site.

Installs: 632

Dependents: 0

Stars: 1 463

Watchers: 109

Forks: 175

Open Issues: 71

Language: PHP

0.13.0 2015-02-01 22:02 UTC

README

Gitter

Latest Stable Version Latest Unstable Version License

The CMS for developers. Add content management functionality to any site - plug & play CMS. Manage content like collections, regions, forms and galleries which you can reuse anywhere on your website.

Cockpit

Requirements

  • PHP >= 5.4
  • PDO + SQLite (or MongoDB)
  • GD extension

make also sure that $_SERVER['DOCUMENT_ROOT'] exists and is set correctly.

Installation

  1. Download Cockpit and put the cockpit folder in the root of your web project or via composer composer create-project aheinze/cockpit cockpit --stability="dev"
  2. Make sure that the /cockpit/storage folder and all its subfolders are writable
  3. Go to /cockpit/install via Browser
  4. You're ready to use Cockpit :-)

Usage

Embed Cockpit

Embedding Cockpit is really easy. Just include the following snippet anywhere you want to use Cockpit:

// make cockpit api available
require('path/to/cockpit/bootstrap.php');

Regions

Render regions api:

<div><?php region("address") ?></div>
<div><?=get_region("address") ?></div>

Collections

Loop over collection data:

<?php foreach(collection("posts")->find(["active"=>1]) as $post): ?>
    <div class="post">
        <h3><?=$post["title"];?></h3>
        <p>
            <?=$post["content"];?>
        </p>
    </div>
<?php endforeach; ?>

Documentation

Please visit http://getcockpit.com/docs - any contributions are welcome: https://github.com/aheinze/cockpit-docs

Language files

Please visit and contribute to https://github.com/aheinze/cockpit-i18n

Support

Google group: CockpitCMS

Credits

  • BrowserStack - Enable cross-browser testing (thanks for sponsoring!).

Copyright and license

Copyright 2013 Agentejo under the MIT license.

The MIT License (MIT)

Copyright (c) 2013 Agentejo, http://agentejo.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.