🚀 Introdução
- Antes de começar, certifique‑se de que o Node.js e o npm estão instalados no seu sistema. Se ainda não os tiver, você pode baixá‑los no site oficial do Node.js.
- 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, Discord 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.
⚙️ Criando o arquivo de configuração do squarecloud
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.
▶️ Iniciar a Aplicação
- Se o campo
START
não estiver definido no arquivo de configuração, a Square Cloud por padrão executaránode
com opções de otimização e parâmetros específicos. Se o campoSTART
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
.
🖥️ Preparando seu projeto Node.js
📁 Arquivos de configuração essenciais
Ao preparar seu projeto Node.js 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 nopackage.json
.
🤔 Por que excluir esses arquivos?
Existem várias razões para excluirnode_modules
e package-lock.json
antes de enviar seu projeto:
-
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. -
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. - 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.
📄 Arquivos Obrigatórios
Três arquivos são necessários para hospedar seu projeto Node:- squarecloud.app/.config
- mainFile.js/.ts (Exemplo de arquivo principal)
- package.json (Arquivo de dependências)
a Square Cloud suporta
TypeScript
nativamente, executando seu projeto via
ts-node, mas é recomendado sempre compilar para JavaScript
, já que somos
uma plataforma de produção.💡 Solução de problemas
O arquivo principal é inválido ou está corrompido
O arquivo principal é inválido ou está corrompido
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
.Memória insuficiente
Memória insuficiente
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.
📤 Enviando o Projeto para a Square Cloud
Após preparar os arquivos do projeto, você pode enviá‑los para a Square Cloud e hospedar sua aplicação.Acesse o Dashboard da Square Cloud e faça o upload dos arquivos do seu projeto.
