Saltar al contenido principal

🚀 Introducción

  • Antes de empezar, puedes optar por usar el runtime de Bun en tu proyecto. Si aún no tienes Bun instalado localmente, tienes dos opciones principales:
  • Instalar mediante npm (recomendado por compatibilidad con npx durante el deploy):
npm install bun
  • O instalar Bun mediante el instalador oficial (consulta la documentación de Bun para las instrucciones de instalación nativa).
  • Al añadir bun como dependencia, puedes usar npx bun en el campo START de squarecloud.app para iniciar tu aplicación con Bun. Consulta más abajo, en la sección “Cómo iniciar tu aplicación”, ejemplos de START.
  • A continuación, tendrás que 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.

▶️ Cómo iniciar tu aplicación

  • Para usar el runtime de Bun en el entorno Node.js de Square Cloud, primero añade el paquete bun a tu proyecto (por ejemplo, npm install bun) para que el comando npx bun esté disponible en el entorno de ejecución.
  • Luego, define el campo START en tu squarecloud.app con el comando que inicia tu aplicación usando Bun. Ejemplo:
OR .config
START=npx bun main.js
Como alternativa, si necesitas ejecutar scripts de package.json con bun, usa:
START=npx bun run start
  • Recuerda: si el campo START está definido, el valor que contenga se ejecutará directamente. Para más información sobre los parámetros del archivo de configuración, visita parámetros de configuración.
  • Si la carpeta node_modules no existe, Square Cloud ejecutará npm install --no-package-lock --no-audit --no-fund para instalar las dependencias y limpiar la carpeta .npm.
Si tienes la intención de usar Bun como runtime, recomendamos añadir bun como dependencia (npm install bun) para garantizar que npx bun esté disponible en el entorno de ejecución durante el deploy. En los proyectos en los que prefieras usar el instalador nativo de Bun, verifica la compatibilidad y los requisitos de tu build antes de optar por este enfoque.

🖥️ Preparando el proyecto

📁 Archivos de configuración esenciales

Al preparar tu proyecto BUN 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.
El archivo de configuración (squarecloud.app/.config) debe estar ubicado en la raíz del archivo zip. De lo contrario, Square Cloud no podrá encontrarlo durante el deploy.

🗑️ 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 basándose en package.json.

🤔 ¿Por qué excluir estos archivos?

Existen varias razones para excluir node_modules y package-lock.json antes de subir tu proyecto:
  1. Consistencia de la instalación: No subir node_modules garantiza que las dependencias sean instaladas por el entorno de producción, lo que resulta en un build consistente y libre de discrepancias del sistema local.
  2. 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.
  3. 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.
Al hacer esto, garantizas que tu aplicación BUN esté preparada de forma óptima para el alojamiento en Square Cloud.

📄 Archivos requeridos

Se necesitan tres archivos para alojar tu proyecto BUN:

💡 Solución de problemas

Este error ocurre cuando el archivo definido como “main” para tu aplicación en el archivo de configuración no existe, está mal escrito, o la ruta es incorrecta. Si tu archivo principal está dentro de una carpeta, por ejemplo, debes indicar folder/file.js.
La cantidad mínima de RAM requerida para alojar un bot es 256MB y para un sitio/API es 512MB. Sin embargo, dependiendo del tamaño y la complejidad de tu aplicación, puede ser aconsejable asignar una cantidad mayor 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 de tu proyecto Bun, el siguiente paso es subirlos a Square Cloud y poner tu aplicación en línea. Hay varias formas de subirlos, pero cubriremos dos: mediante el Dashboard o mediante la CLI.

A través del panel

1

Accede a la página de subida

Accede a la página de subida y sube el archivo zip de tu proyecto.
2

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

Despliega tu proyecto

Por último, haz clic en el botón “Deploy” para alojar tu proyecto en Square Cloud.
Tras el despliegue, puedes monitorear el estado y los logs de tu proyecto desde el panel.
Subiendo aplicación a Square Cloud

A través de la CLI

Para usar este método, necesitas crear un archivo de configuración llamado squarecloud.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.
1

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:
npm install -g @squarecloud/cli
Si ya la tienes, te recomendamos actualizarla. Para ello, ejecuta el siguiente comando en tu terminal:
squarecloud update
2

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

Sube tu proyecto

Por último, para desplegar tu aplicación en Square Cloud usando la CLI, necesitas ejecutar el siguiente comando:
squarecloud upload 
O si creaste el zip manualmente, puedes usar:
squarecloud upload --file <path/to/zip> 

Contáctanos

Si continúas enfrentando dificultades técnicas, nuestro equipo de soporte especializado está disponible para ayudarte. Contáctanos y estaremos encantados de ayudarte a resolver cualquier problema.