Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/connor4312/slimrr

Single file app for making static sites with minimal backend
https://github.com/connor4312/slimrr

Last synced: about 2 months ago
JSON representation

Single file app for making static sites with minimal backend

Awesome Lists containing this project

README

        

# Slimrr: An easy static site framework

Got tired of building a whole application just for making static sites non-redundant? There's an app for that, It's fairly simple to use and takes away the fiddly bits.

Moving on, let's get into it all.

How to use
-------------------------


Basic HTML files like `name.html` will be rendered as [Mustache](http://mustache.github.io/) templates when `example.com/name` is requested. Files ending in `name.php` will be `required`. It's expected that those PHP pages will return their content as a string.

Error files will also be looked for in the pages directory; to add a custom 404 page, for example, make `pages/404.html`.

If you put a config.php alongside the index.php, the parameters in the config will be passed along to the template. Note that you should *not* use this for data operations. Instead, make a PHP page than renders a template passing in the data.

This is *not* made to be an MVC replacement, just a simple system for easily making static websites sane.

The application is based on the [Slim](http://www.slimframework.com/) framework.

Download links!
-------------------------------
Versions will be listed here when they are released/archived.

Thanking people for stuff
------------------------

This is a list of people who helped somehow with the project:


NameContributionTwitter Handle


ConnorBuilt it all.

@ConnorPeet



AndrewContributor
@CypherServers



JonathanFixed the bloody README ;)
@JFKingsley

Licensing
------------
This project is licensed under the MIT license so use it how you want, just don't sue me, and we can all be happy.