🚀 Einführung
- Stelle vor dem Start sicher, dass Node.js und npm auf deinem System installiert sind. Falls noch nicht, kannst du sie von der offiziellen Node.js-Website herunterladen.
- Anschließend musst du ein Konto bei Square Cloud erstellen, was über die Anmeldeseite möglich ist. Du kannst das Konto per E-Mail, GitHub oder beidem erstellen.
- Zuletzt benötigst du einen aktiven kostenpflichtigen Plan in deinem Konto. Du kannst unsere Pläne ansehen und einen passenden hier erwerben.
⚙️ Konfiguration der squarecloud.app-Datei
Wenn du deine Anwendung über die Square Cloud Website hochlädst, kannst du diesen Abschnitt ignorieren. Die Website erstellt die
squarecloud.app Konfigurationsdatei automatisch für dich.Mehr erfahren: So erstellst du die Konfigurationsdatei für Square Cloud.
Die squarecloud.app Datei ist eine Konfigurationsdatei, die zur
Konfiguration deiner Anwendung verwendet wird; sie dient dazu, den Namen, die
Beschreibung, die Version, die Hauptdatei und weiteres zu definieren.
📄 Erforderliche Dateien
- JavaScript
- TypeScript
- Wenn das Feld
STARTin der Konfigurationsdatei nicht definiert ist, führt Square Cloud standardmäßignodemit Optimierungsoptionen und bestimmten Parametern aus. Ist das FeldSTARTdefiniert, wird der darin enthaltene Wert direkt ausgeführt. Weitere Informationen zu den Parametern der Konfigurationsdatei findest du unter Konfigurationsparameter.
- Wenn der Ordner
node_modulesnicht existiert, führt Square Cloudnpm install --no-package-lock --no-audit --no-fundaus, um die Abhängigkeiten zu installieren, und bereinigt den Ordner.npm.
🖥️ Das Projekt vorbereiten
📁 Wesentliche Konfigurationsdateien
Wenn du dein Node.js-Projekt für den Deploy auf Square Cloud vorbereitest, stelle sicher, dass du die Konfigurationsdatei (squarecloud.app/.config) und die wesentlichen Dateien deiner Anwendung in eine ZIP-Datei einschließt.
🗑️ Vor dem Hochladen auszuschließende Dateien
node_modules: Dieser Ordner muss nicht hochgeladen werden, da er während der Installation in der Produktion neu erstellt wird.package-lock.json: Diese Datei ist nicht erforderlich, da die Produktionsumgebung die Abhängigkeiten auf Basis vonpackage.jsoninstalliert.
🤔 Warum diese Dateien ausschließen?
Es gibt mehrere Gründe,node_modules und package-lock.json vor dem Hochladen deines Projekts auszuschließen:
-
Konsistenz der Installation: Wenn
node_modulesnicht hochgeladen wird, ist gewährleistet, dass die Abhängigkeiten von der Produktionsumgebung installiert werden, was zu einem konsistenten Build ohne Abweichungen des lokalen Systems führt. -
Aktuelle Installationen: Die Produktionsumgebung installiert die neuesten kompatiblen Versionen der in
package.jsonaufgeführten Abhängigkeiten und sorgt so für einen sauberen Start deiner Anwendung. - Verringerung der Upload-Größe: Wenn diese Ordner nicht enthalten sind, verringert sich die Größe der hochgeladenen Datei, was den Upload-Vorgang beschleunigt und den Deploy effizienter macht.
📄 Erforderliche Dateien
Zum Hosten deines Node-Projekts sind drei Dateien erforderlich:- squarecloud.app/.config
- mainFile.js/.ts (Beispiel für eine Hauptdatei)
- package.json (Abhängigkeitsdatei)
Square Cloud unterstützt
TypeScript nativ und führt dein Projekt über
ts-node aus, es wird jedoch immer empfohlen, zu JavaScript zu kompilieren, da wir
eine Produktionsplattform sind.💡 Fehlerbehebung
Die Hauptdatei ist ungültig oder beschädigt
Die Hauptdatei ist ungültig oder beschädigt
Dieser Fehler tritt auf, wenn die als „main” für deine Anwendung in der
Konfigurationsdatei definierte Datei nicht existiert, falsch geschrieben ist oder der Pfad
falsch ist. Wenn sich deine Hauptdatei zum Beispiel in einem Ordner befindet,
musst du
folder/file.js angeben.Unzureichender Arbeitsspeicher
Unzureichender Arbeitsspeicher
Die minimale Menge an RAM, die zum Hosten eines Bots erforderlich ist, beträgt 256 MB und für
eine Website/API 512 MB. Abhängig von Größe und Komplexität
deiner Anwendung kann es jedoch ratsam sein, eine größere Menge RAM zuzuweisen, um
zu vermeiden, dass deiner Anwendung der Speicher ausgeht und sie abstürzt.
📤 So hostest du dein Projekt
Nachdem du nun alle Dateien für dein Node.js-Projekt vorbereitet hast, besteht der nächste Schritt darin, sie auf Square Cloud hochzuladen und deine Anwendung online zu stellen. Es gibt mehrere Möglichkeiten zum Hochladen, wir behandeln jedoch zwei: über das Dashboard oder über die CLI.Über das Dashboard
Upload-Seite aufrufen
Rufe die Upload-Seite auf und lade die ZIP-Datei deines Projekts hoch.
Umgebung konfigurieren
Nachdem du deine ZIP-Datei hochgeladen hast, musst du den Namen, die Hauptdatei oder Runtime-Umgebung und weitere Einstellungen für dein Projekt konfigurieren.
Wenn du ein Web-Projekt hochlädst, achte darauf, “Web Publication” auszuwählen und deinem Projekt eine Subdomain zuzuweisen.
Wenn du ein Web-Projekt hochlädst, achte darauf, “Web Publication” auszuwählen und deinem Projekt eine Subdomain zuzuweisen.
Über die CLI
Um diese Methode zu nutzen, musst du eine Konfigurationsdatei mit dem Namensquarecloud.app im Stammverzeichnis deines Projekts erstellen. Diese Datei enthält die notwendige Konfiguration für dein Projekt.
Mehr erfahren: So erstellst du die Konfigurationsdatei für Square Cloud.
Die Datei squarecloud.app ist eine Konfigurationsdatei, mit der deine Anwendung konfiguriert wird; sie dient dazu, deine Umgebung zu definieren.
CLI installieren
Zuerst musst du die CLI in deiner Umgebung installiert haben. Falls du sie noch nicht hast, führe den folgenden Befehl in deinem Terminal aus:Falls du sie bereits hast, empfehlen wir, sie zu aktualisieren. Führe dazu den folgenden Befehl in deinem Terminal aus:
- Windows
- Linux, macOS und WSL
Authentifizieren
Um dich zu authentifizieren und weitere CLI-Befehle zu nutzen, findest du deinen Autorisierungsschlüssel hier, indem du auf “Request API Key” klickst. Nachdem du deinen Autorisierungsschlüssel erhalten hast, führe den folgenden Befehl aus: