🚀 Introduction
- Avant de commencer, assurez-vous que Node.js et npm sont installés sur votre système. Si ce n’est pas encore le cas, vous pouvez les télécharger depuis le site officiel de Node.js.
- Ensuite, vous devrez créer un compte sur Square Cloud, ce qui peut se faire via la page de connexion. Vous pouvez utiliser votre e-mail, GitHub, ou les deux pour créer le compte.
- Enfin, vous devez disposer d’un plan payant actif sur votre compte. Vous pouvez consulter nos plans et en acheter un selon vos besoins ici.
⚙️ Configuration du fichier squarecloud.app
Si vous téléversez votre application via le site Web de Square Cloud, vous pouvez ignorer cette section. Le site crée automatiquement le fichier de configuration
squarecloud.app pour vous.En savoir plus : comment créer le fichier de configuration pour Square Cloud.
Le fichier squarecloud.app est un fichier de configuration qui sera utilisé pour
configurer votre application ; il servira à définir le nom, la description,
la version, le fichier principal, entre autres choses.
📄 Fichiers requis
- JavaScript
- TypeScript
- Si le champ
STARTn’est pas défini dans le fichier de configuration, Square Cloud exécutera par défautnodeavec des options d’optimisation et des paramètres spécifiques. Si le champSTARTest défini, la valeur qu’il contient sera exécutée directement. Pour plus d’informations sur les paramètres du fichier de configuration, consultez les paramètres de configuration.
- Si le dossier
node_modulesn’existe pas, Square Cloud exécuteranpm install --no-package-lock --no-audit --no-fundpour installer les dépendances et nettoyer le dossier.npm.
🖥️ Préparer le projet
📁 Fichiers de configuration essentiels
Lors de la préparation de votre projet Node.js pour le deploy sur Square Cloud, assurez-vous d’inclure le fichier de configuration (squarecloud.app/.config) et les fichiers essentiels de votre application dans un fichier zip.
🗑️ Fichiers à exclure avant le téléversement
node_modules: Ce dossier n’a pas besoin d’être téléversé, car il sera recréé lors de l’installation en production.package-lock.json: Ce fichier n’est pas nécessaire, car l’environnement de production installera les dépendances à partir depackage.json.
🤔 Pourquoi exclure ces fichiers ?
Il existe plusieurs raisons d’exclurenode_modules et package-lock.json avant de téléverser votre projet :
-
Cohérence de l’installation : Ne pas téléverser
node_modulesgarantit que les dépendances sont installées par l’environnement de production, ce qui donne un build cohérent et exempt des divergences du système local. -
Installations à jour : L’environnement de production installera les dernières versions compatibles des dépendances listées dans
package.json, offrant un démarrage propre à votre application. - Réduction de la taille du téléversement : Ne pas inclure ces dossiers réduit la taille du fichier téléversé, ce qui accélère le processus de téléversement et rend le deploy plus efficace.
📄 Fichiers requis
Trois fichiers sont nécessaires pour héberger votre projet Node :- squarecloud.app/.config
- mainFile.js/.ts (Exemple de fichier principal)
- package.json (Fichier de dépendances)
Square Cloud prend en charge
TypeScript nativement, exécutant votre projet via
ts-node, mais il est toujours recommandé de compiler en JavaScript, car nous sommes
une plateforme de production.💡 Dépannage
Le fichier principal est invalide ou corrompu
Le fichier principal est invalide ou corrompu
Cette erreur se produit lorsque le fichier défini comme « main » pour votre application dans le
fichier de configuration n’existe pas, est mal écrit, ou que le chemin
est incorrect. Si votre fichier principal se trouve dans un dossier, par
exemple, vous devez spécifier
folder/file.js.Mémoire insuffisante
Mémoire insuffisante
La quantité minimale de RAM requise pour héberger un bot est de 256 Mo et pour
un site/API de 512 Mo. Cependant, selon la taille et la complexité de
votre application, il peut être conseillé d’allouer une plus grande quantité de RAM pour
éviter que votre application ne manque de mémoire et ne plante.
📤 Comment héberger votre projet
Maintenant que vous avez préparé tous les fichiers de votre projet Node.js, l’étape suivante consiste à les téléverser sur Square Cloud et à mettre votre application en ligne. Il existe plusieurs façons de téléverser, mais nous en couvrirons deux : via le Dashboard ou via la CLI.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.
Si vous téléversez un projet web, veillez à sélectionner « Publication Web » et à définir un sous-domaine pour votre projet.
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.
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 :Si vous l’avez déjà, nous vous recommandons de la mettre à jour. Pour cela, exécutez la commande suivante dans votre terminal :
- Windows
- Linux, macOS et WSL
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 :