Merge pull request #44 from jekuer/dev_v2

V2

Author: jekuer

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [jekuer]

.github/ISSUE_TEMPLATE.md

@@ -16,8 +16,6 @@
 -   [ ] My change requires a change to the Readme.md.
 -   [ ] I have updated the Readme.md accordingly.
 -   [ ] I have read the **CONTRIBUTING** document.
--   [ ] I have added tests to cover my changes.
--   [ ] All new and existing tests passed.
 
 Pull requests should be thought of as a conversation. There will be some back and forth when trying to get code merged into this or any other project. With all but the simplest changes you can and should expect that the maintainers of the project will request changes to your code. Please be aware of that and check in after you open your PR in order to get your code merged in cleanly.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,5 @@
 deploy.php
 node_modules/
-*.map
 
 # Visual Studio Code from https://github.com/github/gitignore/blob/master/Global/VisualStudioCode.gitignore
 # Adjust to your needs.

.gitignore

@@ -0,0 +1,29 @@
+# Changelog
+
+## Version 2
+### 2.0.0
+- major updates to the code base (+ a lot of bug fixes).
+- removing AMP functionality (due to the note by Google to no longer push AMP pages and since the included caching solution is almost as fast without the downsides).
+- adding TailwindCSS support (as optional feature).
+- implementing js and css optimization packages and therefore adding a completely new way to deploy the boilerplate.
+- optimizing documentation and contribution possibilities.
+- nginx option as an alternative for apache.
+- pre-build speed and GDPR YouTube integration feature.
+
+## Version 1
+- 1.4.6: Micro optimization
+- 1.4.5: Bug fixes.
+- 1.4.4: Small updates (mainly to htaccess)
+- 1.4.3: Small updates to htaccess caching
+- 1.4.2: Sitemap bug fix
+- 1.4.1: Optimization of Directus caching, Google Tag Manager, htaccess SSL rewrite, and other tweaks
+- 1.4.0: Bug fixes, Docker compose template, sitemap generator update, and intelligent redirect for multilanguage use
+- 1.3.5: Bug fixes.
+- 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.

.htaccess

@@ -0,0 +1,49 @@
+module.exports = function(grunt) {
+
+  // Project configuration.
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+    paths: {
+      src: {
+        js: 'assets/js/*.js',
+        swcache: 'serviceworker-cache.js'
+      },
+      dest: {
+        jsMin: 'assets/js/all.min.js',
+        swcacheMin: 'serviceworker-cache.min.js'
+      }
+    },
+    clean: {
+      jsMin: '<%= paths.dest.jsMin %>',
+      swcacheMin: '<%= paths.dest.swcacheMin %>'
+    },
+    uglify: {
+      swcache: {
+        options: {
+          compress: true,
+          mangle: true,
+          sourceMap: true
+        },
+        src: '<%= paths.src.swcache %>',
+        dest: '<%= paths.dest.swcacheMin %>'
+      },
+      jsassets: {
+        options: {
+          compress: true,
+          mangle: true,
+          sourceMap: true
+        },
+        src: '<%= paths.src.js %>',
+        dest: '<%= paths.dest.jsMin %>'
+      }
+    }
+  });
+
+  // Load the plugin that provides the "clean" and "uglify" tasks.
+  grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+
+  // Default task(s).
+  grunt.registerTask('default', ['clean', 'uglify']);
+
+};

CHANGELOG.md

@@ -1,7 +1,6 @@
 # PHP Microsite Boilerplate
 
-[![pagespeed-100](https://img.shields.io/badge/Lighthouse%20PageSpeed-100-success.svg)](https://developers.google.com/speed/pagespeed/insights/?url=https://phpmicrosite.jenskuerschner.de)
-[![amp-valid](https://img.shields.io/badge/AMP-valid-success.svg)](https://validator.ampproject.org/#url=https%3A%2F%2Fphpmicrosite.jenskuerschner.de%2Famp%2F)
+[![pagespeed-100](https://img.shields.io/badge/Lighthouse%20PageSpeed-100-success.svg)](https://pagespeed.web.dev/report?utm_source=psi&utm_medium=redirect&url=https://phpmicrosite.jenskuerschner.de)
 [![pwa-valid](https://img.shields.io/badge/PWA-valid-success.svg)](https://phpmicrosite.jenskuerschner.de/)
 [![w3c-css-valid](https://img.shields.io/badge/W3C%20CSS-valid-success.svg)](https://jigsaw.w3.org/css-validator/validator?uri=https%3A%2F%2Fphpmicrosite.jenskuerschner.de%2F&profile=css3svg&usermedium=all)
 [![LICENSE](https://img.shields.io/badge/license-GPL%203.0-blue.svg)](https://github.com/jekuer/php-microsite-boilerplate/blob/master/LICENSE.txt)
@@ -15,87 +14,88 @@ Furthermore, it is often not possible to use most solutions, if you need to depl
 
 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.
+* 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.
+* You therefore do not care about clean code a lot ;).
 
 Demo: <https://phpmicrosite.jenskuerschner.de/>
 
 ## Key Features
 
--   Easy routing.
--   [Accelerated Mobile Pages (AMP)](https://amp.dev/) prepared.
--   [Progressive Web App (PWA)](https://web.dev/progressive-web-apps/) prepared.
--   Multilanguage prepared.
--   [Directus CMS](https://directus.io/) 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](https://securityheaders.com/) (.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. 
-    -   Check the option to auto-redirect within multi-language at index.php and all.js. 
-    -   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!
+* Easy routing.
+* [Progressive Web App (PWA)](https://web.dev/progressive-web-apps/) prepared.
+* Multilanguage prepared.
+* [Directus CMS](https://directus.io/) integration (incl. local cache).
+* Docker compose for local development.
+* [TailwindCSS](https://tailwindcss.com/) included (optional).
+* GDPR and CCPA ready.
+* Intelligent serviceworker cache.
+* Gettext support for easy translation (+ fallback if not installed on the server).
+* SEO optimized.
+* Automated sitemap generation.
+* Optimized for Social sharing.
+* Speed- & GDPR-optimized YouTube-Integration.
+* Optional CSS and JavaScript optimization with prepared build scripts.
+* Extensive in-code documentation.
+* [Security Headers](https://securityheaders.com/) (.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.
+
+## Usage
+
+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. Check the nginx_deployment.sh - it is a pre-configured bash script to setup your nginx webserver. 
+  * Adjust the values within config.php and also mind files, which are mentioned in the comments there. Setup a connection to your Directus CMS if used.
+  * 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. 
+  * Check the option to auto-redirect within multi-language at index.php and all.js. 
+  * 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. If you use the prepared build script, you do not need to worry about this part. 
+  * Adjust the footer at /templates/footer.php to your needs. 
+  * Find more details in the in-code documentation - it's a well documented playground!
+
+3. That is basically it regarding adjustments. You can find a more detailed sample setup guide [at the corresponding Medium blog post here](https://medium.com/@jenskuerschner/build-a-kick-ass-php-microsite-in-under-3h-f21b27b904d2).
+
+4. Building the project, hardly depends on your configuration! If you are using the TailwindCSS integration, you need to use the included build script, which requires NodeJS! If you are going plain, you can skip on that. However, not using the build scripts would also not merge and minify the css and js files. Therefore, if possible for you, it is hardly recommended. For building:
+  * make sure you are within the project's root directory with your terminal.
+  * run `npm install`.
+  * run `npm run build` to let the magic happen.
+  * That's it. Feel free to do this manually on your local machine and upload it to your host - or use some build pipelines at whatever tool you are using.
 
 BTW: It is recommended to use a CDN service (e.g. [Cloudflare](https://www.cloudflare.com/)) in order to speed it up even more.
 
+## Local Development Setup
+
+For local development, you can make use of the included docker-compose.yml
+1. Update the container name in the yml file.
+2. Download and install Docker Desktop.
+3. Adjust the `$the_page_url` in the config.php temporarily to "/".
+4. Run `docker-compose up -d` in the terminal at the project's root directory.
+5. Open the project at `localhost:80` (mind that you might see an SSL error - should be no blocker),
+6. Happy coding and testing.
+
 ## Contributing
 
 Anyone is welcome to contribute, but mind the [guidelines](.github/CONTRIBUTING.md):
 
--   [Bug reports](.github/CONTRIBUTING.md#bugs)
--   [Feature requests](.github/CONTRIBUTING.md#features)
--   [Pull requests](.github/CONTRIBUTING.md#pull-requests)
-
-## Changelog
-
--   1.4.6: Micro optimization
--   1.4.5: Bug fixes.
--   1.4.4: Small updates (mainly to htaccess)
--   1.4.3: Small updates to htaccess caching
--   1.4.2: Sitemap bug fix
--   1.4.1: Optimization of Directus caching, Google Tag Manager, htaccess SSL rewrite, and other tweaks
--   1.4.0: Bug fixes, Docker compose template, sitemap generator update, and intelligent redirect for multilanguage use
--   1.3.5: Bug fixes.
--   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.
+* [Bug reports](.github/CONTRIBUTING.md#bugs)
+* [Feature requests](.github/CONTRIBUTING.md#features)
+* [Pull requests](.github/CONTRIBUTING.md#pull-requests)
 
 ## License
 
-The code is available under the [GPU 3.0 license](LICENSE.txt).
+The code is available under the [GPL 3.0 license](LICENSE.txt).
+You can basically do anything with it, but mind that if you want to distribute your work based on this code, your work needs to be GPL licensed as well.
+This means that you can easily build your website with it, since this is no distribution. Distribution would be the case, if you sell a project based on this code to others or if you create public projects (no matter if you sell them or not). Even this would be all fine, as long as you license those projects also with GPL. :)
+Check the [license file](LICENSE.txt) for all details.
+
 
 ## Inspired by