Zum Hauptinhalt springen

Einführung

Um auf Square Cloud zu entwickeln und zu hosten, ist es wichtig, einer strukturierten Abfolge von Konfigurationen und Voraussetzungen zu folgen. Dieser technische Leitfaden deckt den gesamten Prozess ab, von der anfänglichen Einrichtung bis zum Produktions-Deployment.

Voraussetzungen

  • Square Cloud Konto: Registriere dich über die Registrierungsseite mit deiner E-Mail-Adresse.
  • Aktiver kostenpflichtiger Plan: Stellt dedizierte Ressourcen und optimierte Leistung für deine Anwendung sicher. Sieh dir unsere verfügbaren Pläne an und wähle den passendsten für deine Bedürfnisse.

Projekt erstellen

Um eine NestJS-Anwendung zu erstellen, müssen Node.js und npm auf deinem System installiert sein, bevor du den folgenden Schritten folgst.

CLI-Installation

Um die Befehlszeilenschnittstelle (CLI) von NestJS zu verwenden, musst du sie global auf deinem System installieren. Führe den folgenden Befehl aus:
npm install -g @nestjs/cli
Dieser Befehl installiert das Paket @nestjs/cli global auf deinem System, sodass du den Befehl nest von überall in deinem Terminal verwenden kannst.

Projekt entwickeln

Um ein neues NestJS-Projekt zu erstellen, führe den folgenden Befehl aus:
nest new my-app
In diesem Befehl wird nest new my-app verwendet, um ein neues NestJS-Projekt zu erstellen. Der Befehl nest new ist ein Werkzeug, das mit nest, der NestJS-CLI (Command Line Interface), geliefert wird. Er dient dazu, eine neue NestJS-Anwendung zu initialisieren. my-app ist der Name der neuen Anwendung. Dieser Befehl erstellt ein neues Verzeichnis namens my-app und richtet die notwendigen Dateien und Abhängigkeiten für eine grundlegende NestJS-Anwendung ein. Nachdem du das NestJS-Projekt mit dem Befehl nest new my-app generiert hast, ist die Datei, die du ändern musst, um den Port zu ändern, main.ts. Diese Datei befindet sich im Stammverzeichnis deines Projekts, innerhalb des Ordners src.
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(80); // Change the port number here to 80
}
bootstrap();
Port 80 ist der Standardport für HTTP-Verkehr.
Du kannst deinen Entwicklungsserver mit dem folgenden Befehl starten:
npm run start:dev

Projekt bauen

NestJS verwendet TypeScript, daher musst du deinen TypeScript-Code in JavaScript kompilieren, bevor du deine Anwendung ausführst. Du kannst deine Anwendung kompilieren, indem du den folgenden Befehl ausführst:
npm run build
Dieser Befehl führt das in deiner package.json-Datei definierte build-Skript aus, das wiederum den Befehl nest build ausführt. Dieser Befehl kompiliert deinen TypeScript-Code in JavaScript.
Nach dem Ausführen dieses Befehls befinden sich die kompilierten JavaScript-Dateien im Verzeichnis dist deines Projekts. Diese Dateien sind es, die du zum Ausführen deiner Anwendung in einer Produktionsumgebung verwendest.
Die Hauptdatei zum Ausführen deiner Anwendung ist dist/main.js.

Deploying

Nachdem du deine Projektdateien vorbereitet hast, kannst du sie nun zu Square Cloud hochladen und dein Projekt hosten. Erstelle dazu eine ZIP-Datei, die alle deine Projektdateien enthält.

Über das Dashboard

1

Upload-Seite aufrufen

Rufe die Upload-Seite auf und lade die ZIP-Datei deines Projekts hoch.
2

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.
3

Projekt bereitstellen

Klicke abschließend auf die Schaltfläche “Deploy”, um dein Projekt auf Square Cloud zu hosten.
Nach dem Deploy kannst du den Status und die Logs deines Projekts über das Dashboard überwachen.
Anwendung wird auf Square Cloud hochgeladen

Über die CLI

Um diese Methode zu nutzen, musst du eine Konfigurationsdatei mit dem Namen squarecloud.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.
1

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:
npm install -g @squarecloud/cli
Falls du sie bereits hast, empfehlen wir, sie zu aktualisieren. Führe dazu den folgenden Befehl in deinem Terminal aus:
squarecloud update
2

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:
squarecloud auth login
3

Projekt hochladen

Um deine Anwendung schließlich über die CLI auf Square Cloud bereitzustellen, musst du den folgenden Befehl ausführen:
squarecloud upload 
Oder falls du die ZIP-Datei manuell erstellt hast, kannst du Folgendes verwenden:
squarecloud upload --file <path/to/zip> 

Weitere Ressourcen

Weitere Informationen über NestJS und seine Werkzeuge findest du in der offiziellen NestJS-Dokumentation. Dort findest du detaillierte Anleitungen, Tutorials und API-Dokumentation, die dir helfen, das Beste aus NestJS herauszuholen.

Fehlerbehebung

Eigene Domain

Um eine eigene Domain (z. B. mysite.com) anstelle der Standard-URL mysite.squareweb.app zu verwenden, benötigst du den Standard-Plan oder höher. Die Subdomain wird über das Feld SUBDOMAIN in der Konfigurationsdatei festgelegt.

Mindestanforderungen an den Arbeitsspeicher

Minimum: 512MB RAM für einfache Websites/APIs. Für Seiten mit Frameworks (Next.JS, React, Vue, Angular usw.) empfehlen wir stets mindestens 1GB RAM. Für größere Anwendungen solltest du mehr RAM zuweisen, damit der Anwendung nicht der Speicher ausgeht und sie abstürzt.

Diese Seite konnte nicht gefunden werden.

Prüfe, ob die Subdomain/Domain mit dem übereinstimmt, was im Feld SUBDOMAIN oder in den Einstellungen der eigenen Domain konfiguriert ist. Wenn du die Seite gerade erst hochgeladen hast, warte bis zu 60 Sekunden, bis Square den ersten Zugriff aktiviert.

Die Seite hat zu lange zum Antworten gebraucht…

Prüfe, ob du in der Anwendung Port 80 und Host 0.0.0.0 korrekt konfiguriert hast. Wir empfehlen die Verwendung der von Square erzwungenen Umgebungsvariablen: PORT und HOST aus der .env-Datei.

Kontaktiere uns

Falls du weiterhin technische Schwierigkeiten hast, steht dir unser spezialisiertes Support-Team zur Verfügung. Kontaktiere uns und wir helfen dir gerne, jedes Problem zu lösen.