quicky

CLI Quicky

Una herramienta CLI que optimiza el despliegue y la gestión de los proyectos de Next.js y Node.js autohospedados, permitiendo la inicialización, la implementación de GitHub, actualización, eliminación y administración de aplicaciones, junto con una configuración sin esfuerzo de dominios y certificados SSL, simplificando todo el ciclo de vida de las aplicaciones web en servidores remotos.

Características

• ? Integración de GitHub : Inicializar, implementar y administrar proyectos Next.js y Node.js de repositorios privados y públicos de GitHub.
• Gestión de procesos : Aproveche PM2 para el ciclo de vida y monitoreo de la aplicación.
• Mantenimiento del proyecto : actualice o elimine fácilmente proyectos implementados.
• Automatización de dominio y SSL : configurar automáticamente NGINX para dominios personalizados y certificados SSL, lo que le permite agregar/eliminar dominios de sus proyectos.
• Descripción general de la configuración : enumere e inspeccione los detalles de todos los proyectos implementados y sus dominios.
• ? Gestión de Webhook : Configurar, administrar y actualizar Webhooks para implementaciones automatizadas.
• Acceso al tablero : Administre y monitoree su servidor Webhook a través de un tablero basado en la web.
• ? Gestión de registros : Ver registros de salida y error para su servidor Webhook.

Requisitos previos

Para instalar Quicky, primero adquiera un servidor Ubuntu Linux de un proveedor como DigitalOcean o Hetzner.

Después de configurar su servidor, conéctese a él (por ejemplo, a través de SSH) e instale Node.js y NPM ejecutando los siguientes comandos:

sudo apt update
sudo apt install -y nodejs npm

Instalación

Instale Quicky globalmente usando npx o npm :

npx quicky@latest install

o

sudo npm install -g quicky

Nota : El comando sudo es necesario para la instalación global y para evitar problemas de permiso al configurar dominios.

Uso

1. Inicializar Quicky

quicky init

Este comando le pedirá que ingrese sus credenciales de GitHub y configuraciones básicas para configurar sus proyectos.

Quicky requiere que su token de acceso y nombre de usuario de GitHub interactúen con sus repositorios. Para crear un nuevo token, siga estos pasos:

1. Visite su página de tokens de acceso personal de GitHub y asegúrese de usar tokens (clásico) .
2. Haga clic en Generar un token nuevo .
3. Seleccione los alcances requeridos para el acceso al repositorio.
4. Haga clic en Generar token .
5. Copie el token y dárselo a Quicky como su token de acceso GitHub. Este token se almacenará localmente para uso futuro.

Para habilitar la implementación continua, Quicky solicita una URL webhook para implementaciones automatizadas. Utiliza su token GitHub para configurar un oyente de webhook y crear dinámicamente webhooks. Deberá crear un subdominio (por ejemplo, webhook.example.com ) que señala la dirección IP de su servidor. Esto se puede hacer agregando un registro A DNS con la dirección IPv4 de su servidor.

2. Implementar un proyecto

quicky deploy

Quicky ahora admite la implementación de proyectos Next.js y Node.js. Durante el proceso de implementación, se le solicitará que seleccione el tipo de proyecto:

• Next.js
• Nodo.js

Implementación de un proyecto Next.js

Siga las indicaciones para seleccionar su repositorio Next.js. Quicky manejará la implementación y la configuración automáticamente.

Implementación de un proyecto Node.js

Antes de implementar un proyecto Node.js, asegúrese de que su archivo de aplicación principal se denomina index.js . Tiene la opción de especificar si su proyecto usará un puerto:

• Con puerto : proporcione el número de puerto (por ejemplo, 3000). Quicky lo guardará en el archivo .env , lo que le permite apuntar dominios a su proyecto.
• Sin puerto : sin especificar un puerto, los dominios no pueden dirigirse al proyecto, lo que hace que funcione únicamente como un servicio de fondo.

Este comando le pedirá que proporcione:

• Su nombre de usuario de GitHub o cualquier nombre de organización
• El nombre del repositorio
• Tipo de proyecto ( next.js o node.js )
• Si se selecciona Node.js :
  • Si su proyecto usa un puerto
    • En caso afirmativo, el número de puerto en el que debe ejecutarse el proyecto (por ejemplo, 3000)

Variables de entorno : durante la implementación, se le preguntará si desea agregar variables de entorno a su proyecto. Quicky se encargará de guardar el número de puerto en el archivo .env de su proyecto si corresponde.

3. Administrar proyectos

quicky manage

Enumera todos los proyectos implementados y le permite comenzar , detener , reiniciar , actualizar o eliminar un proyecto específico.

4. Actualizar un proyecto de PID

quicky update < pid >

Actualiza un proyecto específico de su PID con los últimos cambios del repositorio de GitHub.

5. Descripción general de la configuración

quicky list

Muestra una descripción general de todos los proyectos implementados, incluidos los siguientes detalles:

• PID : ID de proyecto.
• Propietario : nombre de usuario o nombre de la organización de GitHub.
• Repositorio : Nombre del repositorio de GitHub.
• Puerto : número de puerto en el que se está ejecutando el proyecto.
• Estado de PM2 : estado actual del proceso PM2.
• Última actualización : fecha y hora de la última implementación/actualización.

6. Dominios

Antes de agregar un dominio a su proyecto, debe:

1. ? Compre un nombre de dominio de un registrador como Namecheap o GoDaddy.
2. Cree un registro A DNS que apunte a la dirección IPv4 de su servidor.

Una vez que tenga su dominio, puede administrarlo fácilmente con el siguiente comando:

quicky domains

Este comando le permite agregar y eliminar sin esfuerzo dominios y subdominios para sus proyectos.

7. Webhooks

Quicky proporciona un servidor Webhook incorporado para actualizar automáticamente sus proyectos cuando los cambios se impulsan a GitHub. Aquí le mostramos cómo configurarlo:

Configuración del servidor Webhook

1. Requisitos previos

   • Asegúrese de tener un subdominio (por ejemplo, webhook.example.com) que señala la dirección IP de su servidor
   • Agregue un registro A DNS con la dirección IPv4 de su servidor

2. Configuración inicial

   quicky webhooks

   Este comando:

   • Compruebe si el servidor webhook se está ejecutando
   • Guiarlo a través del proceso de configuración si es necesario
   • Solicitar la configuración de Webhook

3. Configuración

   • Deberá proporcionar una URL de webhook (formato: https: /// webhook)
   • El servidor Webhook se iniciará automáticamente después de la configuración

4. Verificar la configuración

   quicky webhooks status

   Esto muestra:

   • Estado de ejecución del servidor
   • Opciones para reiniciar/detener el servidor
   • Acceso a registros de servidor

Tablero de webhook

1. Configuración de acceso del tablero

   quicky webhooks dashboard

   • Configurar el nombre de usuario y la contraseña
   • Las credenciales se almacenan de forma segura

2. Panel de acceso

   • Abra su navegador a https: /// Dashboard
   • Inicie sesión con sus credenciales
   • Monitorear el estado de webhook
   • Ver registros de webhook

Administrar webhooks

Use quicky webhooks con estos comandos:

• status : verifique el estado del servidor Webhook
• restart - Reiniciar el servidor Webhook
• stop : detener el servidor Webhook
• logs : Ver registros de servidor Webhook
• dashboard : acceda al tablero de webhook

8. Actualizar Quicky

quicky upgrade

Actualiza Quicky a la última versión.

9. Desinstalar Quicky

quicky uninstall

Elimina Quicky de su sistema.

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo LICENSE para obtener más detalles.

Autor

• Alohe

¿Siéntete libre de comunicarse conmigo? @alemalohe si tienes alguna pregunta o retroalimentación!

Que contribuye

¡Las contribuciones son bienvenidas! Lea el archivo contribuyente para obtener pautas sobre cómo comenzar.