Guide de Déploiement de l'API Node.js Express avec TypeScript et MongoDB sur VPS

Prérequis

• Accès à un serveur VPS (Linux recommandé, Ubuntu ou Debian)
• Accès SSH au serveur
• Projet Node.js Express avec TypeScript prêt à être déployé
• Compte MongoDB Atlas ou accès à une base MongoDB distante

Étapes de Déploiement

1. 1Préparer le serveur VPS
   • Connectez-vous à votre serveur via SSH :

   ssh utilisateur@adresse_ip_du_serveur

   Copier

   Copié !
   • Mettez à jour les paquets système :

   sudo apt update && sudo apt upgrade -y

   Copier

   Copié !
   • Installez Node.js et npm :

   curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
   sudo apt-get install -y nodejs

   Copier

   Copié !
   • Vérifiez l'installation :

   node -v
   npm -v

   Copier

   Copié !
   • Installez PM2 (gestionnaire de processus) :

   sudo npm install -g pm2

   Copier

   Copié !
2. 2Transférer le projet sur le serveur
   • Option 1 : Utilisez SCP pour transférer votre projet (depuis votre machine locale) :

   scp -r /chemin/local/projet utilisateur@adresse_ip_du_serveur:/chemin/destination/

   Copier

   Copié !
   • Option 2 : Clonez depuis un dépôt Git :

   git clone https://votre-depot-git.com/projet.git

   Copier

   Copié !
3. 3Configurer le projet
   • Naviguez vers le dossier du projet :

   cd /chemin/destination/projet

   Copier

   Copié !
   • Créez un fichier .env :

   nano .env

   Copier

   Copié !
   • Ajoutez les variables d'environnement nécessaires :

   MONGODB_URI=mongodb+srv://username:password@cluster.mongodb.net/database
   JWT_SECRET=votre_secret_jwt
   PORT=3000
   NODE_ENV=production

   Copier

   Copié !
   • Installez les dépendances :

   npm install --production

   Copier

   Copié !
4. 4Compiler le projet TypeScript
   • Installez les dépendances de développement si nécessaire :

   npm install --only=dev

   Copier

   Copié !
   • Compilez le code TypeScript :

   npx tsc

   Copier

   Copié !
   • Vérifiez que les fichiers JavaScript ont été générés (généralement dans un dossier dist/ ou build/)

   ls dist

   Copier

   Copié !
5. 5Configurer PM2 pour gérer l'application
   • Créez un fichier de configuration ecosystem.config.js :

   nano ecosystem.config.js

   Copier

   Copié !
   • Ajoutez la configuration suivante :

   module.exports = {
     apps: [{
       name: 'api-app',
       script: 'dist/index.js',
       instances: 'max',
       exec_mode: 'cluster',
       env: {
         NODE_ENV: 'production',
       }
     }]
   };

   Copier

   Copié !
   • Démarrez l'application avec PM2 :

   pm2 start ecosystem.config.js

   Copier

   Copié !
   • Configurez PM2 pour démarrer avec le système :

   pm2 startup
   pm2 save

   Copier

   Copié !
6. 6Configurer Nginx comme reverse proxy
   • Installez Nginx :

   sudo apt install nginx -y

   Copier

   Copié !
   • Créez un fichier de configuration pour votre application :

   sudo nano /etc/nginx/sites-available/mon-app

   Copier

   Copié !
   • Ajoutez la configuration suivante :

   server {
       listen 80;
       server_name votre_domaine.com www.votre_domaine.com;
   
       location / {
           proxy_pass http://localhost:3000;
           proxy_http_version 1.1;
           proxy_set_header Upgrade $http_upgrade;
           proxy_set_header Connection 'upgrade';
           proxy_set_header Host $host;
           proxy_cache_bypass $http_upgrade;
       }
   }

   Copier

   Copié !
   • Activez la configuration :

   sudo ln -s /etc/nginx/sites-available/mon-app /etc/nginx/sites-enabled/

   Copier

   Copié !
   • Vérifiez la configuration Nginx :

   sudo nginx -t

   Copier

   Copié !
   • Redémarrez Nginx :

   sudo systemctl restart nginx

   Copier

   Copié !
7. 7Configurer HTTPS avec Let's Encrypt (optionnel)
   • Installez Certbot :

   sudo apt install certbot python3-certbot-nginx -y

   Copier

   Copié !
   • Obtenez un certificat SSL :

   sudo certbot --nginx -d votre_domaine.com -d www.votre_domaine.com

   Copier

   Copié !
   • Suivez les instructions à l'écran
   • Vérifiez le renouvellement automatique :

   sudo certbot renew --dry-run

   Copier

   Copié !
8. 8Tester l'application
   • Accédez à votre domaine dans un navigateur : http://votre_domaine.com (ou https:// si vous avez configuré SSL)
   • Testez les endpoints API via Swagger UI (généralement accessible via /api-docs).
   • Vérifiez les logs pour détecter d'éventuelles erreurs :

   pm2 logs api-app

   Copier

   Copié !

Remarques

Spécificités du projet

Pour les mises à jour futures, vous pouvez créer un script de déploiement simple qui automatise ces étapes (pull des modifications Git, compilation, redémarrage de l'application).