project sire
A databaseless site rendering engine
fuzzy76/sire
A databaseless site rendering engine
- Thursday, March 3, 2016
- by fuzzy76
- Repository
- 1 Watchers
- 0 Stars
- 2 Installations
- PHP
- 0 Dependents
- 0 Suggesters
- 0 Forks
- 0 Open issues
- 1 Versions
- 0 % Grown
Sire - A databaseless site rendering engine
A small webapp in PHP for rendering a site from a backend of pages., (*1)
First version supports pages as markdown/commonmark and Git backend through Plates templates., (*2)
Installation
Requirements
- Composer
- git command available from PHP
- PHP 5.4
Composer packages in use
How to
composer create-project --stability dev fuzzy76/sire
- Copy config.default.php to config.php and edit the contents to suit your site.
- 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
, (*3)
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