fuzzy76/sire

A databaseless site rendering engine

dev-master 2016-03-03 12:19 UTC

Requires

• php: >=5.4.0
• cypresslab/gitelephant: ~1.1
• league/commonmark: ^0.13
• league/plates: 3.*

BSD-2-Clause

• Håvard Pedersen

• cms
• web

README

A small webapp in PHP for rendering a site from a backend of pages.

First version supports pages as markdown/commonmark and Git backend through Plates templates.

Installation

Requirements

• Composer
• git command available from PHP
• PHP 5.4

Composer packages in use

• Plates
• gitElephant
• CommonMark

How to

1. composer create-project --stability dev fuzzy76/sire
2. Copy config.default.php to config.php and edit the contents to suit your site.
3. Create a folder data/backend which PHP has write permissions for, and check out your backend inside (automated soon!).

Optionally add http://yoursite.com/sire/updatehook as a webhook to your Git provider. You can run directly from source with php -S localhost:8000 index.php

Roadmap

v1.0

• Create homepage for Sire, with Sire.
• Real documentation?
• Use template engine for error pages
• Fix initial cloning for git backend
• Changeable themes
• Add license file (BSD 2-clause)
• Use an open source router implementation (like Aria.Router).

v1.1 (or later)

• Page metadata header (title etc) for markdown.
• Support edit-links to repository provider (autodetect GitHub / BitBucket GIT repositories).
• Figure out a way to serve static files directly through .htaccess (atleast for some backends)
• Support more backends (Local directory and Evernote are both high on the list).
• Support more filetypes (textile, html, txt, source code, etc).
• Implement some special pages (all pages, etc).
• Implement search (backend-specific implementation).
• Better configuration format (YML?)
• PHPUnit tests