php microsite boilerplate

PHP Microsite -Kesselplatte

PHP Micross Boilerplate ist ein PHP -Framework, um einfache, aber stark funktionale, schnelle und sichere Websites auf jeder Umgebung zu erstellen.

Die meisten Frameworks und sogar Kesselplatten erfordern einen anstrengenden Einrichtungsvorgang, bei dem Sie mehrere Abhängigkeiten installieren müssen. Dies führt zu einem riesigen Codeaufwand, den Sie oft nicht brauchen. All diese Komplexität ist auch ein potenzielles Risiko für Ihre Website. Darüber hinaus ist es oft nicht möglich, die meisten Lösungen zu verwenden, wenn Sie ihn im billigsten gemeinsam genutzten Hosting -Plan bereitstellen müssen.

Dieses Projekt möchte Ihnen einen Framework und eine Vorlage für diesen genauen Fall zur Verfügung stellen:

• Sie müssen eine ziemlich kleine Website mit einigen Funktionen erstellen.
• Sie wählen PHP, da Sie serverseitige Skripts durchführen möchten, während PHP möglicherweise auch die einzige Sprache ist, die im Grunde genommen alle Hosting-Optionen ausgeführt wird.
• Sie bauen dieses Ding selbst oder mit maximal 1 anderen Person, was bewährte Praxis, aber komplexe Codestruktur mehr als unnötiger Overhead als ein hilfreiches Konzept macht.
• Sie müssen es schnell erledigen, während Sie keine Kompromisse hinsichtlich Sicherheit oder Leistung erstellen möchten.
• Sie kümmern sich daher nicht um sauberen Code;).

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

Schlüsselmerkmale

• Einfaches Routing.
• Progressive Web App (PWA) vorbereitet.
• Multilanguage vorbereitet.
• Directus CMS -Integration (inkl. Lokaler Cache).
• Docker komponieren für die lokale Entwicklung.
• Rückenwindcss enthalten (optional).
• DSGVO und CCPA bereit.
• Intelligenter Servicearbeiter -Cache.
• GetText -Unterstützung für eine einfache Übersetzung (+ Fallback, wenn nicht auf dem Server installiert).
• SEO optimiert.
• Automatisierte Sitemap -Generation.
• Optimiert für den sozialen Teilen.
• Speed- & GDPR-optimierte YouTube-Integration.
• Optionale CSS- und JavaScript -Optimierung mit vorbereiteten Build -Skripten.
• Umfangreiche In-Code-Dokumentation.
• Sicherheitsheader (.htaccess oder via PHP)
• Mehrere Sicherheitsfunktionen (die meisten von ihnen erfordern einen Apache -Server!)
• Bereit, die GIT -Bereitstellung auszuführen.
• Entwickelt, um es Ihnen extrem einfach zu machen, Funktionen zu entfernen oder Ihre eigenen Dinge hinzuzufügen.

Verwendung

1. Laden Sie den jeweiligen Zweig/Tag herunter und laden Sie ihn in den Ordner Ihrer Website hoch - oder klonen Sie das Repo, wie Sie möchten.

2. Passen Sie es an Ihr Projekt an:

• Überprüfen Sie die Datei .htaccess, wenn Sie sie auf Apache ausführen. Achten Sie auf die Sicherheits -Header und Orte, an denen ein Domain/ein Pfad angegeben wird (suchen Sie nach Ihrer Domain.com).
• Wenn Sie es nicht auf Apache ausführen, überprüfen Sie den Index.php für die Sicherheitsheader -Setup und stellen Sie sicher, dass jede Anforderung (mit Ausnahme von Dateien) an den Index.Php gesendet wird. Überprüfen Sie die nginx_deployment.sh - Es handelt sich um ein vorkonfiguriertes Bash -Skript, um Ihren Nginx -Webserver einzurichten.
• Passen Sie die Werte in config.php und auch Mind -Dateien an, die in den Kommentaren dort erwähnt werden. Richten Sie bei Verwendung eine Verbindung zu Ihrem Directus CMS ein.
• Überprüfen Sie /templates/Ageneral_meta.php und erstellen Sie die jeweiligen Favicons.
• Definieren Sie Ihre Seiten auf der Routing.php. (Mind Legal Notice und Datenschutzbestimmungen, um die DSGVO -konform zu bleiben!)
• Erstellen Sie diese Seiten (wie zuvor angegeben) als einzelne PHP -Dateien innerhalb /Seiten.
• Erstellen Sie die jeweiligen Dateien in /Controller bei Bedarf in Ihrem Fall.
• Überprüfen Sie die Option zur automatischen Redaktion innerhalb von Multisprachlingen unter Index.php und Base.js.
• Erstellen Sie die Website mit diesen Seiten, dem style.css und der Base.js. Machen Sie sich auf die Minimierung dieser Dateien oder die Anpassung der Art und Weise, wie sie bei /templates/Header.php und /templates/foter.php eingeschlossen werden. Wenn Sie das vorbereitete Build -Skript verwenden, müssen Sie sich keine Sorgen um diesen Teil machen.
• Passen Sie die Fußzeile an /templates/footer.php an Ihre Anforderungen an.
• Weitere Details finden Sie in der In -Code -Dokumentation - es ist ein gut dokumentierter Spielplatz!

3. Das geht im Grunde genommen in Bezug auf Anpassungen. Hier finden Sie einen detaillierteren Beispiel -Setup -Handbuch im entsprechenden mittleren Blog -Beitrag.

4. Das Erstellen des Projekts hängt kaum von Ihrer Konfiguration ab! Wenn Sie die Tailwindcss -Integration verwenden, müssen Sie das mitgelieferte Build -Skript verwenden, das NodeJs benötigt! Wenn Sie schlicht gehen, können Sie das überspringen. Die Verwendung der Build -Skripte würde jedoch auch die CSS- und JS -Dateien nicht verschmolzen und minifieren. Wenn möglich für Sie, wird es daher kaum empfohlen. Zum Bau:

• Stellen Sie sicher, dass Sie mit Ihrem Terminal im Root Directory des Projekts befinden.
• Führen Sie npm install aus.
• Führen Sie npm run build , um die Magie geschehen zu lassen.
• Das war's. Fühlen Sie sich frei, dies manuell auf Ihrem lokalen Computer zu tun, und laden Sie ihn auf Ihren Host hoch - oder verwenden Sie einige Build -Pipelines im Tool, das Sie verwenden.

BTW: Es wird empfohlen, einen CDN -Dienst (z. B. CloudFlare) zu verwenden, um ihn noch mehr zu beschleunigen.

Lokale Entwicklungssetup

Für die lokale Entwicklung können Sie die enthaltene Docker-compose.yml verwenden

1. Aktualisieren Sie den Containernamen in der YML -Datei.
2. Laden Sie Docker Desktop herunter und installieren Sie es.
3. Passen Sie die $the_page_url in der config.php vorübergehend an "/" an.
4. Führen Sie docker-compose up -d im Terminal im Root Directory des Projekts aus.
5. Öffnen Sie das Projekt bei localhost:80 (denken Sie, dass Sie möglicherweise einen SSL -Fehler sehen - kein Blocker sein).
6. Glückliche Codierung und Tests.

Beitragen

Jeder ist eingeladen, einen Beitrag zu leisten, aber um die Richtlinien kümmert sich:

• Fehlerberichte
• Feature -Anfragen
• Anfragen ziehen

Lizenz

Der Code ist unter der GPL 3.0 -Lizenz verfügbar. Sie können im Grunde alles damit tun, aber wenn Sie Ihre Arbeit auf diesem Code verteilten möchten, muss Ihre Arbeit auch GPL -lizenziert sein. Dies bedeutet, dass Sie Ihre Website problemlos damit erstellen können, da dies keine Verteilung ist. Die Verteilung wäre der Fall, wenn Sie ein Projekt basierend auf diesem Code an andere verkaufen oder öffentliche Projekte erstellen (egal ob Sie es verkaufen oder nicht). Auch dies wäre alles in Ordnung, solange Sie diese Projekte auch mit GPL lizenzieren. :) Überprüfen Sie die Lizenzdatei für alle Details.

Inspiriert von

Dieser Code wurde von der HTML5 -Boilerplate inspiriert.