MrMatrixPL / php-microsite-boilerplate

An extremely simple and lightweight PHP framework/boilerplate to spin-up microsites at high speed. Optimized for Performance, Security, SEO, and Directus CMS.

PHP Microsite Boilerplate

PHP Microsite Boilerplate is a PHP framework to create simple, yet strongly functional, fast, and secure websites on basically every environment.

Most frameworks and even boilerplates require an exhausting setup process, where you need to install multiple dependencies. This leads to a huge overhead of code, which you often do not need. All of those complexity is also a potential risk for your website. Furthermore, it is often not possible to use most solutions, if you need to deploy it on the cheapest shared hosting plan.

This project wants to provide you with a framework and template for this exact case:

• You need to build a rather small website, with some functionality.
• You choose PHP, because you want to do server-side scripting, while PHP is also maybe the only language, that runs on basically all hosting options.
• You build this thing on your own or with a maximum of 1 other person, which makes best practice, but complex code structure more of an unnecessary overhead than a helpful concept.
• You need to get it done fast, while you do not want to make compromises regarding security or performance.
• Ideally, the whole project should run without any dependencies, should not require a specific IDE setup, or any specific tooling (including Saas). You can still build this on top, but for the start one should be able to update it remotely from basically any device.

Demo: https://phpmicrosite.jenskuerschner.de/

Key Features

• Easy routing.
• Accelerated Mobile Pages (AMP) prepared.
• Progressive Web App (PWA) prepared.
• Multilanguage prepared.
• Directus CMS integration (incl. local cache).
• GDPR and CCPA ready (regular site and AMP).
• Intelligent serviceworker cache.
• Gettext support for easy translation (+ fallback if not installed on the server).
• SEO optimized.
• Automated sitemap generation.
• Optimized for Social sharing.
• Extensive in-code documentation.
• Security Headers (.htaccess or via PHP)
• Multiple security features (most of them require an Apache server!)
• Prepared to run git deployment.
• Developed to make it extremely easy for you to remove features or add your own things.

Setup

1. Download the respective branch/tag and upload it to your website's folder - or clone the repo as you like.

2. Adjust it to your project:

   • Check the .htaccess file, if you run it on Apache. Mind the security headers and places, where a domain/path is specified (look for YOURDOMAIN.com).
   • If you do not run it on Apache, check the index.php for the security headers setup and make sure every request (except for files) is send to the index.php.
   • Adjust the value within config.php and also mind files, which are mentioned in the comments there.
   • Check /templates/general_meta.php and create the respective favicons.
   • Define your pages at the routing.php. (Mind legal notice and privacy policy to stay GDPR compliant!)
   • Create those pages (as specified before) as single php files within /pages.
   • Create respective files within /controller if necessary in your case.
   • Build the website with those pages, the style.css, and the all.js. Mind to minimize those files or adjust the way they get included at /templates/header.php and /templates/footer.php.
   • Adjust the footer at /templates/footer.php and /templates/footer_amp.php to your needs.

3. That's basically it.

You can make more changes and use more features, like:

• Setting up a deployment script (sample included) or the Directus integration.
• Do even more - it's a well documented playground!

BTW: It is recommended to use a CDN service (e.g. Cloudflare) in order to speed it up even more.

Contributing

Anyone is welcome to contribute, but mind the guidelines:

• Bug reports
• Feature requests
• Pull requests

Changelog

• 1.3.4: Option to add last udpdate to sitemap via Directus.
• 1.3.3: Optimization of redirect feature and Directus caching.
• 1.3.2: Extensive bug fixing.
• 1.3.1: Individual slug per language.
• 1.3.0: Added Gettext support, including emulation fallback for servers not supporting native gettext.
• 1.2.0: Optimization of language switcher and serviceworker cache; new redirect functionality; automated sitemap generation; better Directus support (incl. local cache).
• 1.1.0: Added better multilanguage support (incl. language switcher).
• 1.0.0: Initial release.

License

The code is available under the GPU 3.0 license.

Inspired by

This code has been inspired by the HTML5 Boilerplate.