Passer au contenu principal

​
Introduction

Pour développer et héberger 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 payant 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.

​
Création du projet

Pour créer une application NestJS, vous devez avoir Node.js et npm installés sur votre système avant de suivre les étapes.

​
Installation de la CLI

Pour utiliser l’interface en ligne de commande (CLI) de NestJS, vous devez l’installer globalement sur votre système. Exécutez la commande suivante : 
npm install -g @nestjs/cli
Cette commande installe le paquet @nestjs/cli globalement sur votre système, vous permettant d’utiliser la commande nest depuis n’importe où dans votre terminal.

​
Développement du projet

Pour créer un nouveau projet NestJS, exécutez la commande suivante : 
nest new my-app
Dans cette commande, nest new my-app est utilisée pour créer un nouveau projet NestJS. La commande nest new est un outil fourni avec nest, la CLI (Command Line Interface) de NestJS. Elle sert à initialiser une nouvelle application NestJS. my-app est le nom de la nouvelle application. Cette commande crée un nouveau répertoire nommé my-app et met en place les fichiers et dépendances nécessaires à une application NestJS de base. Après avoir généré le projet NestJS avec la commande nest new my-app, le fichier que vous devez modifier pour changer le port est main.ts. Ce fichier se trouve à la racine du répertoire de votre projet, dans le dossier src. 
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(80); // Change the port number here to 80
}
bootstrap();
Le port 80 est le port par défaut pour le trafic HTTP.
Vous pouvez démarrer votre serveur de développement avec la commande suivante : 
npm run start:dev

​
Compilation du projet

NestJS utilise TypeScript, vous devez donc compiler votre code TypeScript en JavaScript avant d’exécuter votre application. Vous pouvez compiler votre application en exécutant la commande suivante : 
npm run build
Cette commande exécute le script build défini dans votre fichier package.json, qui lance à son tour la commande nest build. Cette commande compile votre code TypeScript en JavaScript.
Après avoir exécuté cette commande, les fichiers JavaScript compilés se trouveront dans le répertoire dist de votre projet. Ce sont ces fichiers que vous utiliserez pour exécuter votre application dans un environnement de production.
Le fichier principal pour exécuter votre application sera dist/main.js.

​
Déploiement

Après avoir préparé les fichiers de votre projet, vous pouvez maintenant les téléverser sur Square Cloud et héberger votre projet. Pour ce faire, créez un fichier ZIP contenant tous les fichiers de votre projet.

​
Via le tableau de bord

1

Accéder à la page d'upload

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

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

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

​
Via la CLI

Pour utiliser cette méthode, vous devez créer un fichier de configuration nommé squarecloud.app à la racine de votre projet. Ce fichier contiendra la configuration nécessaire à votre projet.

En savoir plus : comment créer le fichier de configuration pour Square Cloud.

Le fichier squarecloud.app est un fichier de configuration qui servira à configurer votre application ; il sera utilisé pour définir votre environnement.
1

Installer la CLI

Tout d’abord, vous devez avoir la CLI installée dans votre environnement. Si ce n’est pas encore le cas, exécutez la commande suivante dans votre terminal :
npm install -g @squarecloud/cli
Si vous l’avez déjà, nous vous recommandons de la mettre à jour. Pour cela, exécutez la commande suivante dans votre terminal :
squarecloud update
2

S'authentifier

Maintenant, pour vous authentifier et utiliser les autres commandes de la CLI, vous trouverez votre clé d’autorisation ici en cliquant sur « Request API Key ». Après avoir obtenu votre clé d’autorisation, exécutez la commande suivante :
squarecloud auth login
3

Téléverser votre projet

Enfin, pour déployer votre application sur Square Cloud à l’aide de la CLI, vous devez exécuter la commande suivante :
squarecloud upload
Ou si vous avez créé le zip manuellement, vous pouvez utiliser :
squarecloud upload --file <path/to/zip>

​
Ressources supplémentaires

Pour plus d’informations sur NestJS et ses outils, consultez la documentation officielle de NestJS. Vous y trouverez des guides détaillés, des tutoriels et une documentation d’API pour vous aider à tirer le meilleur parti de NestJS.

​
Dépannage

​
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. Le sous-domaine est défini par le champ SUBDOMAIN dans le fichier de configuration.

​
Prérequis minimum en RAM

Minimum : 512 Mo de RAM pour les sites web/API simples. Pour les sites utilisant des frameworks (Next.JS, React, Vue, Angular, etc.), nous recommandons toujours 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…

Vérifiez que vous avez correctement configuré le port 80 et l’hôte 0.0.0.0 dans l’application. Nous recommandons d’utiliser les variables d’environnement forcées par Square : PORT et HOST du fichier .env.

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