WebAppTemplate FARM

Full-Stack-Web-App-Vorlage – FARM Stack

Dieses Repository enthält eine Full-Stack-Webanwendungsvorlage, die auf dem FARM-Lösungsstack ausgeführt wird, der für Folgendes steht:

• Flask , ein Backend -Python -Webframework.
• Ein Mazon Web Services, ein Cloud-Dienst, der Software hosten kann.
• React , ein Frontend -JavaScript- Webframework.
• M ySQL, ein relationales Datenbankverwaltungssystem.

Was ist FARM?

Der FARM-Stack ist mehr oder weniger eine Erweiterung des LAMP-Stacks mit diesen bemerkenswerten Änderungen:

• Das Middleware-Framework ist explizit (Flask)
• Wie der MEAN-Stack enthält er eine Anwendungspräsentationsschicht (React).
• Stattdessen wird die Umgebung, in der die Software läuft, durch PaaS/IaaS-Cloud-Computing-Dienste (AWS) ersetzt.
• Es gibt keine Meinung darüber, welches Betriebssystem verwendet werden soll

Flasche

Flask wird zum Schreiben der Web-APIs/Middleware verwendet, die zwischen der Web-Benutzeroberfläche und dem Web-Backend/der Datenbank kommunizieren können. Dies ist der Kern der gesamten Anwendung, der die Teile der Full-Stack-Anwendung zusammenhält.

Beachten Sie, dass diese spezielle Vorlage kein ORM verwendet, sondern stattdessen das pymysql Modul. Dies bedeutet, dass Entwickler SQL-Abfragen schreiben müssen, aber die Komplexität der Abfragen maximieren können, die sie für die Ausführung in der Datenbank benötigen.

Amazon Web Services

AWS ist der Cloud-Dienst, auf dem die Anwendung gehostet werden kann. Wir können den gesamten Software-Stack auf den folgenden Diensten hosten:

• AWS Lambda zum Hosten unserer Anwendungen auf einer serverlosen Infrastruktur. Wir können unsere Flask-APIs auch über Zappa hosten, was die Bereitstellung in der Produktion äußerst einfach macht.
• AWS RDS zum Hosten unserer Datenbank.
• AWS S3 zum Speichern aller möglichen anderen Objekte wie Bilder und Dateien.

Dies bedeutet, dass Entwickler alles auf einer Plattform behalten und den DevOps-/IT-Aufwand minimieren können.

Reagieren

React ist das Framework, auf dem die Web-Benutzeroberfläche ausgeführt wird. Die React-Anwendung kann auch auf AWS Lambda mit NodeJS ausgeführt werden.

Diese Vorlage verwendet JavaScript/JSX, es kann jedoch auch TypeScript verwendet werden.

MySQL

MySQL ist die relationale Datenbank, die das Web-Backend verwendet. Dies kann über den RDS-Service auch auf AWS gehostet werden.

So führen Sie es lokal aus

Um diese Webanwendung auszuführen, muss Folgendes getan werden:

1. Richten Sie eine lokale MySQL-Instanz mithilfe des Schemas in db/ ein.
2. Installieren Sie Module für die API und die Benutzeroberfläche
3. Führen Sie die API und die Benutzeroberfläche lokal aus

Datenbank-Setup

Um die MySQL-Instanz einzurichten, gehen Sie folgendermaßen vor:

1. Erstellen Sie eine MySQL-Datenbankinstanz und stellen Sie eine Verbindung zu ihr her. Die gebräuchlichsten Methoden hierfür sind MySQL Workbench oder mysql auf der Linux-Befehlszeilenschnittstelle.
2. Führen Sie sample.sql innerhalb der Instanz aus. Es wird ein Schema namens SampleInventory erstellt und dann eine Tabelle namens Inventory initialisiert.

API-Setup

Die Codebasis für die Flask-API finden Sie im Verzeichnis api/ .

Erstmalige Einrichtung (macOS)

1. Erstellen Sie eine virtuelle Python-Umgebung mit virtualenv farm-stack nachdem Sie zu diesem Verzeichnis navigiert haben.
2. Aktivieren Sie es mit source farm-stack/bin/activate
3. Navigieren Sie zu api/ und führen Sie pip3 install -r requirements.txt aus, um alle für die API erforderlichen Python-Module zu installieren.
4. Öffnen Sie dbcreds.py im Verzeichnis api/ und bearbeiten Sie die Datenbankanmeldeinformationen nach Bedarf.

Ausführen der API

1. Aktivieren Sie die virtuelle Umgebung von oben.
2. Führen Sie python3 app.py aus, um die API auf http://localhost:8080 auszuführen.

UI-Setup

Die Codebasis für die React-Benutzeroberfläche finden Sie im Verzeichnis ui/ . Diese Vorlage verwendet yarn als Paketmanager; Es ist wichtig, dass Entwickler beim Hinzufügen neuer Module keine anderen Paketmanager wie npm mischen.

Beachten Sie, dass Pakete wie react-bootstrap in dieser Vorlage fehlen.

Erstmalige Einrichtung (macOS)

1. Führen Sie yarn install aus, um alle erforderlichen Abhängigkeiten zu installieren.

Ausführen der Benutzeroberfläche

1. Führen Sie yarn start aus, um im Entwicklungsmodus ausgeführt zu werden.
2. Navigieren Sie im Browser zu http://localhost:3000 .