Deploying Node.js APIs

# CHAPTER 18

Deploying Node.js APIs #

1. Introduction #

2. Learning Objectives #

• Differentiate between Shared Hosting, VPS, and PaaS.

• Protect sensitive data using the dotenv package.

• Prepare a package.json for production deployment.

• Use Process Managers (like PM2) to keep servers alive.

3. Beginner-Friendly Explanation #

4. Step 1: Environment Variables (.env) #

Install: npm install dotenv

Create a .env file in the root of your project:

PORT=8080
MONGO_URI=mongodb+srv://user:SuperSecretPassword!@cluster.mongodb.net/db
JWT_SECRET=MyUltraSecureKey123

CRITICAL: Add .env to your .gitignore file. It must never go to GitHub.

In app.js (At the very top):

require('dotenv').config();

// Now access secrets securely via process.env
mongoose.connect(process.env.MONGO_URI);
app.listen(process.env.PORT);

5. Step 2: Preparing package.json #

In package.json:

"scripts": {
  "start": "node app.js",
  "dev": "nodemon app.js"
}

*Note: Never use nodemon in production! It consumes too much memory. Only use standard node app.js.*

6. Hosting Options #

• Shared Hosting (cPanel): Terrible for Node.js. Avoid if possible.

• VPS (DigitalOcean/Linode): You rent a blank Linux computer. You must install Node, MongoDB, and Nginx manually via the command line. Highly powerful, but difficult for beginners.

• PaaS (Render, Heroku, Railway): The modern standard. You link your GitHub repository. Every time you git push main, the platform automatically downloads your code, runs npm install, and turns on the server.

7. Step 3: Deployment Workflow (PaaS Example) #

1. 1. Push your code to GitHub (without the .env file and without node_modules).

1. 2. Log into the PaaS dashboard and connect your GitHub repo.

1. 3. Because the .env file was ignored, the live server doesn't know your database password! You must manually type your Environment Variables into the PaaS dashboard's settings panel.

1. 4. Click "Deploy". The PaaS runs npm run start automatically. Your API is now live!

8. The Problem with Node in Production (PM2) #

On your live Linux server:

npm install -g pm2
pm2 start app.js --name "my-api"

PM2 forces the Node app to run endlessly in the background. If the app crashes, PM2 detects it and instantly reboots it in milliseconds.

9. Best Practices #

• Cloud Databases: Do not install MongoDB on the same physical server as your Node.js application. If the server goes down, you lose everything. Use a managed database service like MongoDB Atlas. It gives you a connection string (MONGOURI) that you simply paste into your .env file.

• Challenge: Audit your theoretical app.js file. Replace every instance of a hardcoded password, secret key, or port number with the appropriate process.env.VARIABLENAME syntax.

13. MCQs with Answers #

14. Interview Questions #

• Q: Explain the purpose of Environment Variables in a Node.js application. Provide examples of three specific pieces of data that should *always* be stored in .env rather than hardcoded.

• Q: Compare deploying a Node.js application to a raw VPS versus deploying it to a PaaS (like Heroku or Render). What are the trade-offs regarding control and ease of use?

15. FAQs #

16. Summary #

17. Next Chapter Recommendation #