quicky

Quicky Cli

Ein CLI-Tool, das die Bereitstellung und Verwaltung von selbst gehosteten Next.js- und Node.js-Projekten optimiert, die Initialisierung, Bereitstellung von GitHub, Aktualisierung, Löschen und Verwalten von Anwendungen sowie mühelose Einrichtung von Domänen und SSL-Zertifikaten, die gesamte Lebenszyklus von Webanwendungen auf Remote-Servern ermöglicht.

Merkmale

• ? Github -Integration : Initialisieren, Bereitstellen und Verwalten von Projects.JS- und Node.js -Projekten aus privaten und öffentlichen Github -Repositories.
• Prozessmanagement : Nutzen Sie PM2 für den Anwendungslebenszyklus und die Überwachung.
• Projektwartung : Begrenzte Projekte einfach aktualisieren oder entfernen.
• Domain & SSL -Automatisierung : Konfigurieren Sie NGINX automatisch für benutzerdefinierte Domänen und SSL -Zertifikate, sodass Sie Domänen aus Ihren Projekten hinzufügen/entfernen können.
• Konfigurationsübersicht : Listen- und Überprüfung von Details aller bereitgestellten Projekte und ihrer Domänen.
• ? Webhook Management : Richten, Verwalten und Aktualisieren von Webhooks für automatisierte Bereitstellungen.
• Dashboard-Zugriff : Verwalten und überwachen Sie Ihren Webhook-Server über ein webbasiertes Dashboard.
• ? Protokollverwaltung : Ausgabe- und Fehlerprotokolle für Ihren Webhook -Server anzeigen.

Voraussetzungen

Um Quicky zu installieren, erwerben Sie zunächst einen Linux Ubuntu -Server von einem Anbieter wie Digitalocean oder Hetzner.

Stellen Sie nach dem Einrichten Ihres Servers eine Verbindung damit (z. B. über SSH) und installieren Sie Node.js und NPM, indem Sie die folgenden Befehle ausführen:

sudo apt update
sudo apt install -y nodejs npm

Installation

Installieren Sie Quicky weltweit entweder mit npx oder npm :

npx quicky@latest install

oder

sudo npm install -g quicky

Hinweis : Der Befehl sudo ist für die globale Installation und zur Verhinderung von Berechtigungsproblemen bei der Konfiguration von Domänen erforderlich.

Verwendung

1. Initialisieren Sie Quicky

quicky init

In diesem Befehl werden Sie aufgefordert, Ihre GitHub -Anmeldeinformationen und grundlegenden Konfigurationen für die Einrichtung Ihrer Projekte einzugeben.

Quicky erfordert, dass Ihr GitHub -Zugangs -Token und Ihr Benutzername mit Ihren Repositorys interagieren. Befolgen Sie die folgenden Schritte, um ein neues Token zu erstellen:

1. Besuchen Sie Ihre Seite "Personal Access Tokens" GitHub und verwenden Sie unbedingt Token (klassisch) .
2. Klicken Sie auf neues Token generieren .
3. Wählen Sie die erforderlichen Bereiche für den Zugriff auf den Repository aus.
4. Klicken Sie auf Token generieren .
5. Kopieren Sie das Token und geben Sie es Quicky als GitHub Access -Token zur Verfügung. Dieses Token wird lokal für die zukünftige Verwendung gespeichert.

Um eine kontinuierliche Bereitstellung zu ermöglichen, fordert Quicky eine Webhook -URL für automatisierte Bereitstellungen an. Es verwendet Ihr Github -Token, um einen Webhook -Listener einzurichten und Webhooks dynamisch zu erstellen. Sie müssen eine Subdomain (z. B. webhook.example.com ) erstellen, die auf die IP -Adresse Ihres Servers hinweist. Dies kann durch Hinzufügen eines A -Datensatzes mit der IPv4 -Adresse Ihres Servers erfolgen.

2. Bereitstellen eines Projekts

quicky deploy

Quicky unterstützt nun die Bereitstellung von Projects Next.js- und Node.js. Während des Bereitstellungsprozesses werden Sie aufgefordert, den Projekttyp auszuwählen:

• Weiter.js
• Node.js

Bereitstellung eines nächsten.js -Projekts

Befolgen Sie die Eingabeaufforderungen, Ihr nächstes.js -Repository auszuwählen. Quicky behandelt die Bereitstellung und Konfiguration automatisch.

Bereitstellung eines Node.js -Projekts

Stellen Sie vor der Bereitstellung eines Node.js -Projekts sicher, dass Ihre Hauptantragsdatei index.js heißt. Sie haben die Möglichkeit, anzugeben, ob Ihr Projekt einen Port verwendet:

• Mit Port : Geben Sie die Portnummer an (z. B. 3000). Quicky speichert es in der Datei .env so, sodass Sie Domänen auf Ihr Projekt verweisen können.
• Ohne Port : Ohne Angabe eines Ports können Domänen nicht an das Projekt gerichtet werden, was dazu führt, dass er ausschließlich als Hintergrunddienst funktioniert.

In diesem Befehl werden Sie aufgefordert, angeben:

• Ihr Github -Benutzername oder einen Organisationsnamen
• Der Repository -Name
• Projekttyp ( next.js oder node.js )
• Wenn node.js ausgewählt ist:
  • Ob Ihr Projekt einen Port verwendet
    • Wenn ja, die Portnummer, auf der das Projekt ausgeführt werden soll (z. B. 3000)

Umgebungsvariablen - Während der Bereitstellung werden Sie gefragt, ob Sie Ihrem Projekt Umgebungsvariablen hinzufügen möchten. Quicky wird das Speichern der Portnummer in der .env -Datei Ihres Projekts gegebenenfalls verarbeiten, falls zutreffend.

3. Verwalten Sie Projekte

quicky manage

Listet alle bereitgestellten Projekte auf und ermöglicht es Ihnen, ein bestimmtes Projekt zu starten , anzuhalten , neu zu starten , zu aktualisieren oder zu löschen .

4. Aktualisieren Sie ein Projekt von PID

quicky update < pid >

Aktualisiert ein bestimmtes Projekt mit den neuesten Änderungen aus dem GitHub -Repository.

5. Konfigurationsübersicht

quicky list

Zeigt einen Überblick über alle bereitgestellten Projekte an, einschließlich der folgenden Details:

• PID : Project ID.
• Eigentümer : Github Benutzername oder Organisationsname.
• Repository : Name des Github -Repositorys.
• Port : Portnummer, auf der das Projekt ausgeführt wird.
• PM2 Status : Aktueller Status des PM2 -Prozesses.
• Zuletzt aktualisiert : Datum und Uhrzeit der letzten Bereitstellung/Aktualisierung.

6. Domänen

Bevor Sie Ihrem Projekt eine Domain hinzufügen, müssen Sie:

1. ? Kaufen Sie einen Domainnamen von einem Registrar wie Namecheap oder GoDaddy.
2. Erstellen Sie einen A -Datensatz, der auf die IPv4 -Adresse Ihres Servers zeigt.

Sobald Sie Ihre Domain haben, können Sie sie problemlos mit dem folgenden Befehl verwalten:

quicky domains

Mit diesem Befehl können Sie mühelos Domänen und Subdomains für Ihre Projekte hinzufügen und entfernen .

7. Webhooks

Quicky bietet einen integrierten Webhook-Server, um Ihre Projekte automatisch zu aktualisieren, wenn Änderungen an GitHub vorangetrieben werden. Hier erfahren Sie, wie Sie es einrichten:

Einrichten des Webhook -Servers

1. Voraussetzungen

   • Stellen Sie sicher
   • Fügen Sie mit der IPv4 -Adresse Ihres Servers einen DNS -Datensatz hinzu

2. Erstes Setup

   quicky webhooks

   Dieser Befehl wird:

   • Überprüfen Sie, ob der Webhook -Server ausgeführt wird
   • Führen Sie bei Bedarf durch den Setup -Prozess
   • Aufforderung zur Webhook -Konfiguration

3. Konfiguration

   • Sie müssen eine Webhook -URL bereitstellen (Format: https: /// Webhook)
   • Der Webhook -Server startet automatisch nach dem Einrichten

4. Überprüfen Sie das Setup

   quicky webhooks status

   Dies zeigt:

   • Serverauslaufstatus
   • Optionen zum Neustarten/Stop -Server
   • Zugriff auf Serverprotokolle

Webhook Dashboard

1. Setup Dashboard Access

   quicky webhooks dashboard

   • Richten Sie Benutzername und Passwort ein
   • Anmeldeinformationen werden sicher gespeichert

2. Zugriff auf Dashboard

   • Öffnen Sie Ihren Browser in https: /// Dashboard
   • Melden Sie sich mit Ihren Anmeldeinformationen an
   • Überwachen Sie den Webhook -Status
   • Webhook -Protokolle anzeigen

Verwalten von Webhooks

Verwenden Sie quicky webhooks mit diesen Befehlen:

• status - den Status des Webhook -Servers überprüfen
• restart - Starten Sie den Webhook -Server neu
• stop - Stoppen Sie den Webhook -Server
• logs - Webhook -Serverprotokolle anzeigen
• dashboard - Greifen Sie auf das Webhook Dashboard zu

8. Upgrade Quicky

quicky upgrade

Upgrades Quicky auf die neueste Version.

9. Quicky deinstallieren

quicky uninstall

Entfernt Quicky aus Ihrem System.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der LICENSE .

Autor

• Alohe

Fühlen Sie sich frei, mich an mich zu wenden? @alemalohe, wenn Sie Fragen oder Feedback haben!

Beitragen

Beiträge sind willkommen! Bitte lesen Sie die beitragende Datei, um Richtlinien zum Einstieg zu erhalten.