quicky

CLI Quicky

Un outil CLI qui rationalise le déploiement et la gestion des projets auto-hébergés Next.js et node.js, permettant l'initialisation, le déploiement de GitHub, la mise à jour, la suppression et la gestion des applications, ainsi que la configuration sans effort des domaines et des certificats SSL, en simplifiant l'intégralité du cycle de vie des applications Web sur les serveurs distants.

Caractéristiques

• ? Intégration GitHub : Initialiser, déploier et gérer les projets Next.js et node.js à partir de référentiels GitHub privés et publics.
• Gestion des processus : Tirez parti de PM2 pour le cycle de vie et de la surveillance des applications.
• Maintenance du projet : mettez à jour ou supprimez facilement les projets déployés.
• Domain & SSL Automation : configurez automatiquement NGINX pour les domaines personnalisés et les certificats SSL, vous permettant d'ajouter / supprimer des domaines de vos projets.
• Présentation de la configuration : répertoriez et inspectez les détails de tous les projets déployés et de leurs domaines.
• ? WEBHOOK GESTION : Configurer, gérer et mettre à jour WebHooks pour les déploiements automatisés.
• Accès du tableau de bord : gérer et surveiller votre serveur WebHook via un tableau de bord en ligne.
• ? Gestion du journal : afficher les journaux de sortie et d'erreur pour votre serveur WebHook.

Condition préalable

Pour installer Quicky, acquise d'abord un serveur Linux Ubuntu à partir d'un fournisseur tel que DigitalOcean ou Hetzner.

Après avoir configuré votre serveur, connectez-vous (par exemple, via SSH) et installez Node.js et NPM en exécutant les commandes suivantes:

sudo apt update
sudo apt install -y nodejs npm

Installation

Installez Quicky à l'échelle mondiale à l'aide de npx ou npm :

npx quicky@latest install

ou

sudo npm install -g quicky

Remarque : La commande sudo est nécessaire pour l'installation globale et pour éviter les problèmes d'autorisation lors de la configuration des domaines.

Usage

1. Initialiser rapidement

quicky init

Cette commande vous invitera à saisir vos informations d'identification GitHub et vos configurations de base pour la configuration de vos projets.

Quicky nécessite que votre jeton d'accès GitHub et votre nom d'utilisateur interagissent avec vos référentiels. Pour créer un nouveau jeton, suivez ces étapes:

1. Visitez votre page GitHub Personal Access Tokens et assurez-vous d'utiliser des jetons (classiques) .
2. Cliquez sur Générer un nouveau jeton .
3. Sélectionnez les lunettes requises pour l'accès au référentiel.
4. Cliquez sur Générer le jeton .
5. Copiez le jeton et fournissez-le à Quicky comme jeton d'accès GitHub. Ce jeton sera stocké localement pour une utilisation future.

Pour activer le déploiement continu, Quicky demande une URL WebHook pour les déploiements automatisés. Il utilise votre jeton GitHub pour configurer un écouteur WebHook et créer des webhooks dynamiquement. Vous devrez créer un sous-domaine (par exemple, webhook.example.com ) pointant vers l'adresse IP de votre serveur. Cela peut être fait en ajoutant un enregistrement A DNS avec l'adresse IPv4 de votre serveur.

2. Déployer un projet

quicky deploy

Quicky prend désormais en charge le déploiement des projets Next.js et node.js. Pendant le processus de déploiement, vous serez invité à sélectionner le type de projet:

• Next.js
• Node.js

Déploiement d'un projet Next.js

Suivez les invites pour sélectionner votre référentiel Next.js. Quicky gérera automatiquement le déploiement et la configuration.

Déploiement d'un projet Node.js

Avant de déployer un projet Node.js, assurez-vous que votre fichier d'application principal est nommé index.js . Vous avez la possibilité de spécifier si votre projet utilisera un port:

• Avec le port : fournissez le numéro de port (par exemple, 3000). Quicky l'enregistrera dans le fichier .env , vous permettant de pointer des domaines à votre projet.
• Sans port : sans spécifier un port, les domaines ne peuvent pas être dirigés vers le projet, ce qui l'a fait fonctionner uniquement comme un service d'arrière-plan.

Cette commande vous invitera à fournir:

• Votre nom d'utilisateur GitHub ou tout nom d'organisation
• Le nom du référentiel
• Type de projet ( next.js ou node.js )
• Si Node.js est sélectionné:
  • Si votre projet utilise un port
    • Si oui, le numéro de port sur lequel le projet doit s'exécuter (par exemple, 3000)

Variables d'environnement - Pendant le déploiement, il vous sera demandé si vous souhaitez ajouter des variables d'environnement à votre projet. Quicky gérera la sauvegarde du numéro de port dans le fichier .env de votre projet le cas échéant.

3. Gérer les projets

quicky manage

Répertorie tous les projets déployés et vous permet de démarrer , d'arrêter , de redémarrer , de mettre à jour ou de supprimer un projet spécifique.

4. Mettez à jour un projet de PID

quicky update < pid >

Met à jour un projet spécifique par son PID avec les derniers modifications du référentiel GitHub.

5. Présentation de la configuration

quicky list

Affiche un aperçu de tous les projets déployés, y compris les détails suivants:

• PID : ID de projet.
• Propriétaire : nom d'utilisateur GitHub ou nom de l'organisation.
• Référentiel : nom du référentiel GitHub.
• Port : numéro de port sur lequel le projet est en cours d'exécution.
• État PM2 : État actuel du processus PM2.
• Dernière mise à jour : date et heure du dernier déploiement / mise à jour.

6. Domaines

Avant d'ajouter un domaine à votre projet, vous devez:

1. ? Achetez un nom de domaine auprès d'un registraire comme Namecheap ou GoDaddy.
2. Créez un enregistrement A DNS pointant vers l'adresse IPv4 de votre serveur.

Une fois que vous avez votre domaine, vous pouvez facilement le gérer avec la commande suivante:

quicky domains

Cette commande vous permet d'ajouter et de supprimer sans effort des domaines et des sous-domaines pour vos projets.

7. webhooks

Quicky fournit un serveur WebHook intégré pour mettre à jour automatiquement vos projets lorsque les modifications sont poussées vers GitHub. Voici comment le configurer:

Configuration du serveur WebHook

1. Condition préalable

   • Assurez-vous d'avoir un sous-domaine (par exemple, webhook.example.com) pointant vers l'adresse IP de votre serveur
   • Ajoutez un enregistrement A DNS avec l'adresse IPv4 de votre serveur

2. Configuration initiale

   quicky webhooks

   Cette commande sera:

   • Vérifiez si le serveur WebHook s'exécute
   • Vous guider à travers le processus de configuration si nécessaire
   • Invite pour la configuration de webhook

3. Configuration

   • Vous devrez fournir une URL de webhook (format: https: /// webhook)
   • Le serveur WebHook commencera automatiquement après la configuration

4. Vérifiez la configuration

   quicky webhooks status

   Cela montre:

   • État d'exécution du serveur
   • Options pour redémarrer / arrêter le serveur
   • Accès aux journaux des serveurs

Tableau de bord Webhook

1. Configuration de l'accès au tableau de bord

   quicky webhooks dashboard

   • Configurer le nom d'utilisateur et le mot de passe
   • Les informations d'identification sont stockées en toute sécurité

2. Tableau de bord d'accès

   • Ouvrez votre navigateur à https: /// Tableau de bord
   • Connectez-vous avec vos informations d'identification
   • Surveiller l'état de webhook
   • Afficher les journaux Webhook

Gérer les webhooks

Utilisez quicky webhooks avec ces commandes:

• status - Vérifiez l'état du serveur WebHook
• restart - redémarrer le serveur WebHook
• stop - Arrêtez le serveur Webhook
• logs - Afficher les journaux de serveurs WebHook
• dashboard - Accédez au tableau de bord Webhook

8. Mettre à niveau Quicky

quicky upgrade

Améliore rapidement la dernière version.

9. Désinstaller Quicky

quicky uninstall

Supprime rapidement votre système.

Licence

Ce projet est autorisé en vertu de la licence MIT - voir le fichier LICENSE pour plus de détails.

Auteur

• Alohe

N'hésitez pas à me contacter? @alemalohe si vous avez des questions ou des commentaires!

Contributif

Les contributions sont les bienvenues! Veuillez lire le fichier contributif pour les directives sur la façon de commencer.