Pular para o conteúdo principal

​
🚀 Introdução

  • Antes de começar, você pode optar por usar o runtime Bun no seu projeto. Se ainda não tiver o Bun instalado localmente, você tem duas opções principais:
  • Instalar via npm (recomendado para compatibilidade com npx durante o deploy): 
npm install bun
  • Ou instalar o Bun pelo instalador oficial (verifique a documentação do Bun para instruções de instalação nativa).
  • Ao adicionar bun como dependência, você poderá usar npx bun no START do squarecloud.app para iniciar sua aplicação com Bun. Veja mais abaixo na seção “Iniciar a Aplicação” para exemplos de START.
  • Em seguida, será necessário criar uma conta na Square Cloud, o que pode ser feito através da página de login. Você pode usar seu e‑mail, GitHub ou ambos para criar a conta.
  • Por fim, é necessário ter um plano pago ativo na sua conta. Você pode ver nossos planos e adquirir um conforme sua necessidade aqui.

​
⚙️ Configuração do arquivo squarecloud.app

Se você estiver enviando sua aplicação através do website da Square Cloud, você pode ignorar esta seção. O site cria automaticamente o arquivo de configuração squarecloud.app para você.

Saiba mais: como criar o arquivo de configuração para a Square Cloud.

O arquivo squarecloud.app é um arquivo de configuração que será usado para configurar sua aplicação; ele servirá para definir nome, descrição, versão, arquivo principal, entre outras coisas.

​
▶️ Como iniciar sua aplicação

  • Para usar o runtime Bun no ambiente Node.js da Square Cloud, primeiro adicione o pacote bun ao seu projeto (por exemplo npm install bun) para que o comando npx bun esteja disponível no ambiente de execução.
  • Depois, defina o campo START no seu squarecloud.app com o comando que inicia sua aplicação usando Bun. Exemplo:
OU .config
START=npx bun main.js
Alternativamente, se você precisar executar scripts do package.json com bun, use: 
START=npx bun run start
  • Lembre-se: se o campo START estiver definido, o valor nele será executado diretamente. Para mais informações sobre os parâmetros do arquivo de configuração, visite configuration parameters.
  • Se a pasta node_modules não existir, a Square Cloud executará npm install --no-package-lock --no-audit --no-fund para instalar as dependências e limpar a pasta .npm.
Se você pretende usar Bun como runtime, recomendamos adicionar bun como dependência (npm install bun) para garantir que npx bun esteja disponível no ambiente de execução durante o deploy. Em projetos onde você prefere usar o instalador nativo do Bun, verifique a compatibilidade e os requisitos do seu build antes de optar por essa abordagem.

​
🖥️ Preparando o projeto

​
📁 Arquivos de configuração essenciais

Ao preparar seu projeto BUN para deploy na Square Cloud, certifique‑se de incluir o arquivo de configuração (squarecloud.app/.config) e os arquivos essenciais da sua aplicação dentro de um arquivo zip.
O arquivo de configuração (squarecloud.app/.config) deve estar localizado na raiz do arquivo zip. Caso contrário, a Square Cloud não conseguirá encontrá‑lo durante o deploy.

​
🗑️ Arquivos a excluir antes de enviar

  • node_modules: Esta pasta não precisa ser enviada, pois será recriada durante a instalação em produção.
  • package-lock.json: Este arquivo não é necessário pois o ambiente de produção instalará dependências com base no package.json.

​
🤔 Por que excluir esses arquivos?

Existem várias razões para excluir node_modules e package-lock.json antes de enviar seu projeto:
  1. Consistência na instalação: Não enviar node_modules garante que as dependências sejam instaladas pelo ambiente de produção, resultando em um build consistente e livre de discrepâncias do sistema local.
  2. Instalações atualizadas: O ambiente de produção instalará as versões compatíveis mais recentes das dependências listadas no package.json, fornecendo um início limpo para sua aplicação.
  3. Redução do tamanho do upload: Não incluir essas pastas reduz o tamanho do arquivo enviado, acelerando o processo de upload e tornando o deploy mais eficiente.
Fazendo isso, você garante que sua aplicação BUN esteja preparada de forma otimizada para hospedagem na Square Cloud.

​
📄 Arquivos Obrigatórios

Três arquivos são necessários para hospedar seu projeto BUN:

​
💡 Resolução de problemas

Este erro ocorre quando o arquivo definido como “main” para sua aplicação no arquivo de configuração não existe, está escrito incorretamente ou o caminho está errado. Se o seu arquivo principal estiver dentro de uma pasta, por exemplo, você deve informar pasta/arquivo.js.
A quantidade mínima de RAM necessária para hospedar um bot é 256MB e para um site/API é 512MB. No entanto, dependendo do tamanho e complexidade da sua aplicação, pode ser aconselhável alocar uma quantidade maior de RAM para evitar o erro LACK_OF_RAM.

​
📤 Como hospedar seu projeto

Agora que você preparou todos os arquivos do seu projeto Bun, o próximo passo é enviá-los para a Square Cloud e colocar sua aplicação no ar. Existem varias formas de fazer o upload, mas vamos abordar duas: via Dashboard ou via CLI.

​
Via dashboard

1

Acesse a página de upload

Acesse a página de upload e envie seu arquivo zip.
2

Configure seu ambiente

Após fazer o upload do seu arquivo zip, você precisará configurar o nome, o arquivo principal ou o ambiente de execução e outras configurações do seu projeto.
Se você estiver enviando um projeto web, certifique-se de selecionar "Publicação na Web" e definir um subdomínio para o seu projeto.
3

Faça o deploy do projeto

Por fim, clique no botão "Deploy" para hospedar seu projeto no Square Cloud. Após o deploy, você poderá monitorar o status e os registros do seu projeto no painel.

​
Via CLI

Para usar esse método, você precisa criar um arquivo de configuração chamado squarecloud.app no diretório raiz do seu projeto. Esse arquivo conterá a configuração necessária para o seu projeto.

Saiba mais sobre: Como criar arquivo de configuração da Square Cloud.

O arquivo squarecloud.app é um arquivo de configuração que será usado para configurar seu aplicativo; ele será usado para definir seu ambiente.
1

Primeiro Passo

Primeiro, você precisa ter a CLI instalada em seu ambiente. Se você ainda não a possui, execute o seguinte comando em seu terminal:
npm install -g @squarecloud/cli
Se você já a possui, recomendamos atualizá-la. Para fazer isso, execute o seguinte comando em seu terminal:
squarecloud update
2

Segundo Passo

Agora, para autenticar e usar outros comandos da CLI, você encontrará sua chave de autorização aqui clicando em "Solicitar Chave da API". Após obter sua chave de autorização, execute o seguinte comando:
squarecloud auth login
3

Terceiro Passo

Finalmente, para fazer o deploy da sua aplicação para a Square Cloud usando a CLI, você precisa executar o seguinte comando:
squarecloud upload
Ou se já possui o zip criado:
squarecloud upload --file <caminho/para/zip>

​
Contate-nos

Se você continuar enfrentando dificuldades técnicas, nossa equipe de suporte especializada está disponível para auxiliá-lo. Entre em contato conosco e teremos prazer em ajudá-lo a resolver qualquer questão.