simple todo

Einfacher Todo

Einfaches Todo ist eine sehr minimalistische WebApp. Es wurde entwickelt, um den Prozess des Erstellens eines WebApp mithilfe von "objektorientiertem PHP" zu demonstrieren. Diese App ist jedoch sehr minimalistisch, sie enthält alle grundlegenden Eigenschaften einer guten Webanwendung. Es wurde mit reinem PHP völlig objektorientiert erstellt (es wurde kein anderer Framework als Phpunit verwendet, was nur ein Test -Framework ist), HTML, CSS und JavaScript. Derzeit unterstützen diese App mehrere gute Funktionen. Ich werde sie unten beschreiben.

Live

Ich habe die App auf Heroku gehostet und verwende eine kontinuierliche Integration, um Änderungen automatisch und sofort zu versenden (dazu später mehr). Sie können die App mit dem folgenden Link besuchen:

http://simple-todo-rs.herokuapp.com/

Funktionen, die von Simple TODO unterstützt werden

Backend -Funktionen

Auf dem Backend habe ich die folgenden Dinge gebaut:

1. Ein benutzerdefinierter Routing -Motor
2. Hübsche URL -Unterstützung
3. Middleware -Unterstützung (sowohl generische als auch streckenspezifische)
4. Controller, um Anfrage zu bearbeiten
5. Benannte Routen
6. CSRF -Schutz durch Middleware
7. Ein kleiner, aber erweiterbarer und effizienter Templating -Motor
8. Eine bequeme OOP -Möglichkeit zum Zugriff auf globale Variablen (Hinweis: Die Art und Weise, wie ich sie implementiert habe, ist erweitert, aber noch nicht vollständig).

Die App wird unter Verwendung eines völlig objektorientierten Weges erstellt und verfügt über eine starke Typunterstützung, die Pausen während der Entwicklungsphase erkennen und somit die Geschwindigkeit erhöhen kann.

Frontend -Funktionen

1. Eine sehr reaktionsschnelle, schnelle und konsequente Benutzeroberfläche.
2. Caching -Mechanismus, um Daten auf der Client -Seite zu zwischenstrahlen.
3. Optimierte Netzwerkanrufe (IE DB).

Unterstützung und Kommentare testen

Für Unit -Tests verwende ich Phpunit. Ich habe jedoch bereits begonnen, Tests zu schreiben und fortzusetzen, aber es würde irgendwann dauern, bis die gesamte Codebasis abdeckt.

Zu Kommentaren, da die App viele Funktionen abdeckt, habe ich versucht, den Code ausführlich zu schreiben, damit man möglicherweise keine Kommentare benötigt, um den Code zu verstehen (um meine Entwicklerzeit zu verwalten). Aber immer noch zu kommentieren ist die de facto für doc. Ich werde versuchen, die gesamte Codebasis mit der Zeit unter den Kommentaren zu nehmen.

Automatisierte Tests und kontinuierliche Bereitstellung

1. Automatisierte Testunterstützung unter Verwendung von Github -Aktionen und Phpunit.
2. Unterstützung bei der kontinuierlichen Bereitstellung mithilfe von Github -Aktionen und Heroku Git -basiertem Bereitstellungssystem.

[Hinweis: In der App werden automatisierte Tests bei jedem Push ausgeführt, aber nur für Heroku bereitgestellt, wenn der Test erfolgreich ist].

Datenbank

Für Datenbank habe ich PostgreSQL verwendet. Und um Datenbankvorgänge zu verarbeiten, habe ich PHP -PDO zum Perfom -Insert, Löschen, Aktualisieren usw. Operationen verwendet.

Als Randnotiz wurde zum Verwalten von Abhängigkeitskomponisten Composer verwendet.

Für die lokale Nutzung oder Entwicklung

Wenn Sie diese App für Ihre eigene Verwendung oder Entwicklung lokal ausführen möchten, können Sie dies leicht tun. Stellen Sie sicher, dass Sie PHP, Composer und PostgreSQL in Ihrem PC und einer Internetverbindung installiert haben.

Beim ersten Komponisten werden die Abhängigkeiten installiert:

$ php composer.phar install

Erstellen Sie nun ein .env im Projekt Root Directory und geben Sie Ihre DB -Informationen dort wie folgt ein:

DATABASE_URL=postgres:// < username > : < password > @ < hostname > : < port > / < dbname >

Möglicherweise möchten Sie auch andere Informationen in Ihre .env -Datei einfügen (tun Sie nach Ihren Bedürfnissen)

Und dann rennen:

$ php database/migrate.php

Nach dem Erstellen von DB -Tabellen können Sie die Tests ausführen:

$ ./vendor/bin/phpunit

Wenn Tests erfolgreich sind, können Sie die App wie folgt über den Entwicklungs -Webserver von PHP ausführen:

$ php -c < path-to-php.ini > -t public/ -S 127.0.0.1:8000

Besuchen Sie nun 127.0.0.1:8000 in Ihrem Browser, um die WebApp zu verwenden.

Anerkennung

Ich habe Phpunit für Unit-Tests und ein leicht bearbeitetes Skript von DevCoder-Xyz/Php-dotenv verwendet, um .env Datei zu analysieren.

LIZENZ

Dieses Repository wird unter MIT License veröffentlicht. Um mehr über Lizenz zu erfahren, besuchen Sie bitte diesen Link.

Beitragen

Ich denke daran, alle, die sich für WebApp -Entwicklung interessieren, die gesamte Architektur dieses Projekts zu erklären. Ich denke darüber nach, ein Buch (oder eine Tutorial -Art von Ressource) darüber zu planen, wie Sie eine Webanwendung von Grund auf neu erstellen. Wenn Sie etwas dazu haben, einen Beitrag zu leisten oder zu beraten, bin ich alle Ohren. Klopfen Sie einfach klopfen.