Déployer une API NestJS

Introduction

Pour développer et héberger une application NestJS sur Square Cloud, il est essentiel de suivre une séquence structurée de configurations et de prérequis. Ce guide technique couvrira l’ensemble du processus, de la configuration initiale au déploiement en production.

Prérequis

Compte Square Cloud : Inscrivez-vous via la page d’inscription en utilisant votre adresse e-mail.
Plan actif : Garantit des ressources dédiées et des performances optimisées pour votre application. Consultez nos plans disponibles et choisissez celui qui convient le mieux à vos besoins.

Ce guide utilise le runtime Node.js. Testé avec NestJS 12 sur Node.js 24 en septembre 2026.

Créer le projet

Vous avez besoin de Node.js et de npm sur votre machine. Si ce n’est pas le cas, téléchargez-les depuis le site officiel de Node.js. Installez la CLI Nest globalement et créez un projet :

npm install -g @nestjs/cli
nest new my-app

nest new vous demande un gestionnaire de paquets et installe les dépendances dans le nouveau dossier my-app. Démarrez le serveur de développement avec npm run start:dev ; il écoute sur http://localhost:3000.

Générer le build de production

NestJS est écrit en TypeScript : compilez-le donc en JavaScript avant de déployer :

npm run build

Le script build exécute nest build, qui écrit les fichiers compilés dans le dossier dist/. Le fichier d’entrée est dist/main.js, le même fichier que lance le script start:prod.

N’utilisez pas nest start ni npm run start en production. La CLI Nest et TypeScript sont des devDependencies, que Square Cloud n’installe pas (il s’exécute avec NODE_ENV=production). Générez le build sur votre machine et envoyez le dossier dist/ compilé.

Port et hôte

Rien à modifier : le fichier src/main.ts généré lit déjà la variable d’environnement PORT, que Square Cloud définit à 80, et Nest écoute par défaut sur toutes les interfaces réseau. En local, il utilise le port 3000 :

src/main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module.js';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(process.env.PORT ?? 3000);
}
await bootstrap();

Les projets créés avec d’anciennes versions de la CLI Nest peuvent importer ./app.module et se terminer par bootstrap();. C’est la ligne app.listen qui compte.

Configurer Square Cloud

Créez un fichier squarecloud.app à la racine de votre projet :

squarecloud.app

MAIN=dist/main.js
MEMORY=512
VERSION=recommended
DISPLAY_NAME=My NestJS API
SUBDOMAIN=my-nest-api

Square Cloud exécute alors node dist/main.js, la même commande que le script start:prod. Lors d’un envoi via le tableau de bord, définissez dist/main.js comme fichier principal.

Contenu du ZIP

dist/, l’application compilée.
package.json.
squarecloud.app.

Excluez node_modules : Square Cloud installe vos dependencies au premier démarrage.

Déployer et vérifier

Via le tableau de bord

Accéder à la page d'upload

Accédez à la page d’upload et téléversez le fichier zip de votre projet.

Configurer votre environnement

Après avoir téléversé votre zip, vous devrez configurer le nom, le fichier principal ou l’environnement d’exécution ainsi que d’autres paramètres de votre projet.
Si vous téléversez un projet web, veillez à sélectionner « Publication Web » et à définir un sous-domaine pour votre projet.

Déployer votre projet

Enfin, cliquez sur le bouton « Deploy » pour héberger votre projet sur Square Cloud.
Une fois le déploiement effectué, vous pouvez suivre l’état et les logs de votre projet depuis le tableau de bord.

Téléversement d'une application vers Square Cloud

Confirmez que votre application est en ligne

Votre premier déploiement prend généralement moins d’une minute. Dans le tableau de bord, attendez que le statut de votre application affiche « en cours d’exécution » et vérifiez les logs pour détecter d’éventuelles erreurs de démarrage.
Si vous avez déployé un site web ou une API, ouvrez https://<votre-sous-domaine>.squareweb.app dans votre navigateur, vous devriez voir votre application répondre. Si vous avez déployé un bot, envoyez-lui une commande pour confirmer qu’il est en ligne.

Votre application ne démarre pas ? Consultez le guide de dépannage pour les causes les plus courantes et leurs solutions.

Via la CLI

Pour utiliser cette méthode, votre projet a besoin d’un fichier de configuration nommé squarecloud.app à sa racine. Il indique à Square Cloud comment exécuter votre application.

Guide du fichier de configuration

Apprenez comment créer le fichier de configuration squarecloud.app qui définit l’environnement de votre application.

Installer la CLI

Installez la CLI Square Cloud. Si vous l’avez déjà, exécutez la même commande pour la mettre à jour :

curl -fsSL https://cli.squarecloud.app/install | bash

npm install -g @squarecloud/cli@latest

Se connecter

Exécutez la commande ci-dessous. Elle ouvre votre navigateur : approuvez-y la connexion et la CLI est prête. Il n’y a aucune clé API à copier. Pour les scripts et la CI, consultez Authentification de la CLI.

squarecloud auth login

Téléverser votre projet

Depuis le dossier de votre projet, exécutez la commande ci-dessous. La CLI compresse le dossier courant en zip, sans ce que liste squarecloud.ignore, puis l’envoie :

squarecloud upload

Pour téléverser un zip que vous avez créé vous-même, passez-le avec --file :

squarecloud upload --file <path/to/zip>

Confirmez que votre application est en ligne

Votre premier déploiement prend généralement moins d’une minute. Vérifiez le statut et les logs de votre application directement depuis le terminal :

squarecloud app status
squarecloud app logs

Si vous avez déployé un site web ou une API, ouvrez https://<votre-sous-domaine>.squareweb.app dans votre navigateur, vous devriez voir votre application répondre. Si vous avez déployé un bot, envoyez-lui une commande pour confirmer qu’il est en ligne.

Votre application ne démarre pas ? Consultez le guide de dépannage pour les causes les plus courantes et leurs solutions.

Erreurs courantes

Domaine personnalisé

Pour utiliser un domaine personnalisé (par exemple mysite.com) au lieu de l’URL par défaut mysite.squareweb.app, vous avez besoin du plan Standard ou supérieur. L’URL par défaut provient du champ SUBDOMAIN du fichier de configuration. Pour connecter votre domaine, suivez comment configurer votre propre domaine.

Prérequis minimum en RAM

Minimum : 512 Mo de RAM pour les sites web et les API, ce qui suffit pour un build statique sur le runtime statique. Pour les applications qui génèrent les pages sur un serveur (Next.js, Nuxt, Angular SSR et similaires), nous recommandons au moins 1 Go de RAM. Pour les applications plus volumineuses, allouez davantage de RAM afin d’éviter que l’application ne manque de mémoire et ne plante.

Impossible de trouver ce site.

Vérifiez que le sous-domaine/domaine correspond à ce qui est configuré dans le champ SUBDOMAIN ou dans les paramètres du domaine personnalisé. Si vous venez tout juste de mettre en ligne le site, patientez jusqu’à 60 secondes pour que Square active le premier accès.

Le site a mis trop de temps à répondre…

Votre serveur doit écouter sur le port 80 et l’hôte 0.0.0.0. Square Cloud définit les variables d’environnement PORT (80) et HOST (0.0.0.0) dans votre application : lisez-les dans votre code au lieu de coder en dur d’autres valeurs. Un serveur qui n’écoute que sur localhost ou 127.0.0.1 ne reçoit jamais de requêtes.

The main file is invalid or corrupted

dist/main.js manque dans le ZIP. Exécutez npm run build et vérifiez que le dossier dist/ se trouve à la racine du ZIP.

Prochaines étapes

Variables d'environnement

Gardez les secrets et les paramètres hors de votre code et lisez-les à l’exécution.

Domaine personnalisé

Servez votre application sur votre propre domaine, à partir du plan Standard.

Dépannage

Corrigez une application qui ne démarre pas ou un site qui ne répond pas.

Pour en savoir plus sur NestJS, consultez la documentation officielle de NestJS.

Contactez-nous

Si vous rencontrez toujours des difficultés techniques, notre équipe de support spécialisée est disponible pour vous aider. Contactez-nous et nous serons ravis de vous aider à résoudre tout problème. La qualité du support compte pour beaucoup dans la note que les développeurs donnent à Square Cloud, 4,9/5 sur 402 avis sur Google et Trustpilot.

Bots

Sites web

API et backends

Bases de données

Applications auto-hébergées

Guides

Guides de migration

Déployer une API NestJS

Introduction

Prérequis

Créer le projet

Générer le build de production

Port et hôte

Configurer Square Cloud

Contenu du ZIP

Déployer et vérifier

Via le tableau de bord

Via la CLI

Guide du fichier de configuration

Erreurs courantes

Domaine personnalisé

Prérequis minimum en RAM

Impossible de trouver ce site.

Le site a mis trop de temps à répondre…

The main file is invalid or corrupted

Prochaines étapes

Variables d'environnement

Domaine personnalisé

Dépannage

Contactez-nous

​Introduction

​Prérequis

​Créer le projet

​Générer le build de production

​Port et hôte

​Configurer Square Cloud

​Contenu du ZIP

​Déployer et vérifier

​Via le tableau de bord

​Via la CLI

Guide du fichier de configuration

​Erreurs courantes

​Domaine personnalisé

​Prérequis minimum en RAM

​Impossible de trouver ce site.

​Le site a mis trop de temps à répondre…

​The main file is invalid or corrupted

​Prochaines étapes

Variables d'environnement

Domaine personnalisé

Dépannage

​Contactez-nous

Introduction

Prérequis

Créer le projet

Générer le build de production

Port et hôte

Configurer Square Cloud

Contenu du ZIP

Déployer et vérifier

Via le tableau de bord

Via la CLI

Erreurs courantes

Domaine personnalisé

Prérequis minimum en RAM

Impossible de trouver ce site.

Le site a mis trop de temps à répondre…

The main file is invalid or corrupted

Prochaines étapes

Contactez-nous