Pular para o conteúdo principal

🚀 O que é o NPM?

O NPM (Node Package Manager) é o gerenciador de pacotes padrão do Node.js, utilizado para instalar bibliotecas e dependências. Além disso, você pode utilizá-lo para executar scripts de inicialização da sua aplicação.

atenção

Embora o NPM permita executar scripts com npm start, ele não é um gerenciador de processos. Isso significa que ele não oferece tolerância a falhas, reinício automático da aplicação em caso de queda ou travamento, e não mantém o processo em segundo plano. Em caso de ambiente em produção, recomenda-se o uso do gerenciador de processo como o PM2. Para aprender sobre o PM2, clique aqui!.

🛠️ Como utilizar o NPM na SaveinCloud

Na plataforma, você pode integrar o NPM à sua aplicação Node.js de duas maneiras principais:

1️⃣ - Selecionando a Tag "NPM" ao Criar o Ambiente

Durante a criação de um novo ambiente na SaveinCloud, você pode optar por uma imagem pré-configurada que já inclui o Node.js e o NPM instalados. Essa opção agiliza o processo de deploy, permitindo que sua aplicação seja gerenciada pelo NPM desde o início.

NPM Topologia

2️⃣ - Configurando o NPM via Variáveis de Ambiente

Se você já possui um ambiente em execução, é possível configurar o NPM utilizando variáveis de ambiente.

Variáveis de Ambiente - Parte 1

Variáveis de Ambiente - Parte 2

📄 Configuração do Arquivo package.json

Para que o NPM execute sua aplicação corretamente, é necessário possuir o script de inicialização dentro do arquivo de configuração chamado package.json e o mesmo deve estar localizado no diretório /home/jelastic/ROOT - que é o padrão definido na variável de ambiente $ROOT_DIR, podendo ter o diretório alterado conforme necessidade -. Este arquivo define como o NPM deve iniciar a sua aplicação.

info

A plataforma buscará arquivos de entrypoint padrões - como server.js, index.js, app.js - dentro do diretório /home/jelastic/ROOT (nesse caso, é o diretório especificado dentro da variável de ambiente $ROOT_DIR) para realizar o start automático da sua aplicação. Caso o entrypoint da sua aplicação tenha outra nomeação, você pode especificar na variável de ambiente $APP_FILE.

Exemplo de script para inicialização da aplicação no arquivo package.json:

{
"scripts": {
"start": "node ./server.js"
}
}
  • start: é o ponto de entrada da aplicação e será executado com npm start.
atenção

🔒 Certifique-se de liberar no firewall a porta que sua aplicação utiliza para garantir o funcionamento correto. Para aprender sobre Gestão de Firewall, clique aqui!

🧰 Comandos Úteis do NPM

ComandoDescrição
npm installInstala todas as dependências listadas no package.json.
npm install <pacote>Instala um pacote específico localmente.
npm run startExecuta o script definido como start no package.json.
npm run <nome-script>Executa qualquer outro script personalizado definido.
npm outdatedVerifica dependências desatualizadas.
npm updateAtualiza todas as dependências para a última versão permitida.
info

💡 Lembre-se de armazenar o seu arquivo package.json dentro do diretório /home/jelastic/ROOT, pois a plataforma executará o comando npm install para instalar as dependências contidas em seu arquivo a cada reinício da instância (a variável de ambiente $UPDATE_PACKAGES_ON_RESTART precisa estar com o valor true).

🧠 Dúvidas?

Entre em contato com o suporte técnico e envie sua dúvida que estaremos à disposição para te ajudar!