🚀 Introducción
- Antes de comenzar, asegúrate de tener Node.js y npm instalados en tu sistema. Si aún no los tienes, puedes descargarlos desde el sitio web oficial de Node.js.
- A continuación, deberás crear una cuenta en Square Cloud, lo cual puedes hacer a través de la página de inicio de sesión. Puedes usar tu correo electrónico, GitHub o ambos para crear la cuenta.
- Por último, necesitas tener un plan de pago activo en tu cuenta. Puedes ver nuestros planes y adquirir uno según tus necesidades aquí.
⚙️ Configuración del archivo squarecloud.app
Si estás subiendo tu aplicación a través del sitio web de Square Cloud, puedes ignorar esta sección. El sitio crea automáticamente el archivo de configuración
squarecloud.app por ti.Más información: cómo crear el archivo de configuración para Square Cloud.
El archivo squarecloud.app es un archivo de configuración que se usará para
configurar tu aplicación; servirá para definir el nombre, la descripción,
la versión, el archivo principal, entre otras cosas.
📄 Archivos requeridos
- JavaScript
- TypeScript
- Si el campo
STARTno está definido en el archivo de configuración, Square Cloud ejecutará por defectonodecon opciones de optimización y parámetros específicos. Si el campoSTARTestá definido, el valor que contenga se ejecutará directamente. Para obtener más información sobre los parámetros del archivo de configuración, visita parámetros de configuración.
- Si la carpeta
node_modulesno existe, Square Cloud ejecutaránpm install --no-package-lock --no-audit --no-fundpara instalar las dependencias y limpiar la carpeta.npm.
🖥️ Preparando el proyecto
📁 Archivos de configuración esenciales
Al preparar tu proyecto de Node.js para el deploy en Square Cloud, asegúrate de incluir el archivo de configuración (squarecloud.app/.config) y los archivos esenciales de tu aplicación dentro de un archivo zip.
🗑️ Archivos a excluir antes de subir
node_modules: Esta carpeta no necesita subirse, ya que se recreará durante la instalación en producción.package-lock.json: Este archivo no es necesario, ya que el entorno de producción instalará las dependencias con base enpackage.json.
🤔 ¿Por qué excluir estos archivos?
Hay varias razones para excluirnode_modules y package-lock.json antes de subir tu proyecto:
-
Consistencia de la instalación: No subir
node_modulesgarantiza que las dependencias sean instaladas por el entorno de producción, resultando en un build consistente y libre de discrepancias del sistema local. -
Instalaciones actualizadas: El entorno de producción instalará las versiones compatibles más recientes de las dependencias listadas en
package.json, proporcionando un inicio limpio para tu aplicación. - Reducción del tamaño de subida: No incluir estas carpetas reduce el tamaño del archivo subido, acelerando el proceso de subida y haciendo el deploy más eficiente.
📄 Archivos requeridos
Se necesitan tres archivos para alojar tu proyecto de Node:- squarecloud.app/.config
- mainFile.js/.ts (Ejemplo de archivo principal)
- package.json (Archivo de dependencias)
Square Cloud admite
TypeScript de forma nativa, ejecutando tu proyecto a través de
ts-node, pero siempre se recomienda compilar a JavaScript, ya que somos
una plataforma de producción.💡 Solución de problemas
El archivo principal es inválido o está corrupto
El archivo principal es inválido o está corrupto
Este error ocurre cuando el archivo definido como “main” para tu aplicación en el
archivo de configuración no existe, está escrito incorrectamente o la ruta
es incorrecta. Si tu archivo principal está dentro de una carpeta, por
ejemplo, debes especificar
folder/file.js.Memoria insuficiente
Memoria insuficiente
La cantidad mínima de RAM requerida para alojar un bot es de 256MB y para
un sitio/API es de 512MB. Sin embargo, dependiendo del tamaño y la complejidad de
tu aplicación, puede ser recomendable asignar una mayor cantidad de RAM para
evitar que tu aplicación se quede sin memoria y se bloquee.
📤 Cómo alojar tu proyecto
Ahora que has preparado todos los archivos para tu proyecto de Node.js, el siguiente paso es subirlos a Square Cloud y poner tu aplicación en línea. Hay varias formas de subir los archivos, pero cubriremos dos: mediante el Dashboard o mediante la CLI.A través del panel
Accede a la página de subida
Accede a la página de subida y sube el archivo zip de tu proyecto.
Configura tu entorno
Después de subir tu zip, deberás configurar el nombre, el archivo principal o el entorno de ejecución y otros ajustes de tu proyecto.
Si estás subiendo un proyecto web, asegúrate de seleccionar “Publicación Web” y de definir un subdominio para tu proyecto.
Si estás subiendo un proyecto web, asegúrate de seleccionar “Publicación Web” y de definir un subdominio para tu proyecto.
A través de la CLI
Para usar este método, necesitas crear un archivo de configuración llamadosquarecloud.app en el directorio raíz de tu proyecto. Este archivo contendrá la configuración necesaria para tu proyecto.
Aprende más sobre: cómo crear el archivo de configuración para Square Cloud.
El archivo squarecloud.app es un archivo de configuración que se usará para configurar tu aplicación; se utilizará para definir tu entorno.
Instala la CLI
Primero, necesitas tener la CLI instalada en tu entorno. Si aún no la tienes, ejecuta el siguiente comando en tu terminal:Si ya la tienes, te recomendamos actualizarla. Para ello, ejecuta el siguiente comando en tu terminal:
- Windows
- Linux, macOS y WSL
Autentícate
Ahora, para autenticarte y usar otros comandos de la CLI, encontrarás tu clave de autorización aquí haciendo clic en “Request API Key”. Después de obtener tu clave de autorización, ejecuta el siguiente comando: