Rack

Rack — A framework, typically with rails, bars, hooks, or pegs, for holding or storing things.

Rack is a small and simple boilerplate/framework for PHP based web applications that are integrated with the login API of the Cover website. It aims to ease the creation of websites or microservices that only need a small number of forms, tables and views and to provide a familiar project structure among most of Cover's PHP projects. Additionally, anybody with basic OOP skills and a basic understanding of the web should be able to easily comprehend the framework and setup a website.

Rack implements the following features:

• Basic templates with template inheritance
• Form rendering and validation (server side)
• SQL injection safe database interactions
• User authentication through the Cover API

Clone (or fork or download) the Bitbucket repository into the root folder of your project and you're ready to go!

Projects using Rack adhere to the following structure:

📁 Project
├ 📁 include
│ ├ 📁 models
│ │ ├ 📁 migrations
│ │ ├ Model.class.php
│ │ └ … (model definitions)
│ ├ config.php
│ ├ include.php
│ └ … (other Rack logic php files)
├ 📁 static
│ ├ 📁 css
│ ├ 📁 js
│ ├ 📁 img
│ └ … (other static content)
├ 📁 templates
│ ├ error.phtml
│ ├ index.phtml
│ ├ layout.phtml
│ └ … (templates for other views)
├ index.php
└ … (other views)

The include folder is meant Rack's internal logic and possible application-specific extensions to it. It should not contain any views, templates or static files.

To work, a config file include/config.php is needed. A default configuration is provided in include/config.php.default and can be copied to initialize the config.php file. Remember that this config file is likely to contain passwords, so it should be added to the .gitignore file to prevent it from showing up in Git repositories. Do not forget to change it's file permissions to hide it from other users on the system. This can be done with the following command: chmod 700 include/config.php.