How to Set Up Node.js and Run a Node.js Server: A Step-by-Step Guide

4 minute read

How to Set Up Node.js and Run a Node.js Server: A Step-by-Step Guide

Node.js has revolutionized backend development by enabling developers to use JavaScript—a language traditionally confined to browsers—on the server side. Its non-blocking, event-driven architecture makes it ideal for building scalable and high-performance applications. Whether you’re a beginner or an experienced developer, this guide will walk you through setting up Node.js and creating your first server.

What is Node.js?
Prerequisites
Installing Node.js
- Windows
- macOS
- Linux
Verifying the Installation
Creating Your First Node.js Server
- Using the Built-in http Module
- Running the Server
Enhancing Your Server with Express.js
- Installing Express
- Creating an Express Server
Debugging and Troubleshooting
Deploying Your Node.js Server
Conclusion and Next Steps

1. What is Node.js?

Node.js is an open-source, cross-platform JavaScript runtime environment that executes code outside a web browser. Built on Chrome’s V8 JavaScript engine, it allows developers to build server-side applications with JavaScript. Key features include:

Event-Driven Architecture: Handles multiple requests efficiently.
Non-Blocking I/O: Optimizes performance for data-intensive applications.
NPM Ecosystem: Access to over a million packages via the Node Package Manager (NPM).

From APIs to real-time apps, Node.js powers platforms like Netflix, LinkedIn, and Walmart.

2. Prerequisites

Before diving in, ensure you have:

Basic knowledge of JavaScript.
A code editor (e.g., VS Code, Sublime Text).
Terminal/Command Line access.

3. Installing Node.js

Node.js can be installed on all major operating systems. We’ll cover Windows, macOS, and Linux.

Windows

Visit the Node.js Official Website.
Download the LTS (Long-Term Support) version for stability.
Run the installer and follow the prompts.
Check “Automatically install necessary tools” to include npm and build tools.

macOS

Option 1: Installer

Download the macOS installer from the Node.js website.
Open the .pkg file and follow the installation steps.

Option 2: Homebrew

Install Homebrew (if not already installed):

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Install Node.js:
```
brew install node
```

Linux (Ubuntu/Debian)

Option 1: NodeSource Script

Update your package list:
```
sudo apt update
```
Install curl if missing:
```
sudo apt install curl
```

Run the NodeSource installation script for the LTS version:

curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -

Install Node.js:
```
sudo apt install nodejs
```

Option 2: Using NVM (Node Version Manager) NVM allows you to manage multiple Node.js versions:

Install NVM:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash

Restart your terminal or run:
```
source ~/.bashrc
```
Install the latest LTS version:
```
nvm install --lts
```

4. Verifying the Installation

Confirm Node.js and npm (Node Package Manager) are installed:

node -v  # Outputs: v20.x.x (or similar)
npm -v   # Outputs: 10.x.x (or similar)

5. Creating Your First Node.js Server

Let’s build a basic server using Node.js’s built-in http module.

Step 1: Create a Project Directory

Open your terminal and run:

mkdir my-node-server
cd my-node-server

Step 2: Initialize a Node.js Project

Create a package.json file to manage dependencies:

npm init -y  # The `-y` flag skips prompts

Step 3: Write the Server Code

Create a file named app.js and add the following code:

// Import the http module
const http = require('http');

// Create a server instance
const server = http.createServer((req, res) => {
  // Set response headers
  res.writeHead(200, { 'Content-Type': 'text/plain' });
  // Send a response
  res.end('Welcome to the WackyDawg API!');
});

// Define the port
const PORT = 3000;

// Start the server
server.listen(PORT, () => {
  console.log(`Server running at http://localhost:${PORT}/`);
});

Code Explanation:

http.createServer() creates an HTTP server that handles incoming requests.
The callback function (req, res) processes requests and sends responses.
res.writeHead() sets the HTTP status code and headers.
res.end() sends the response body and ends the request cycle.
server.listen() starts the server on the specified port.

Step 4: Run the Server

In the terminal, execute:

node app.js

Visit http://localhost:3000 in your browser. You should see “Welcome to the WackyDawg API!”.

6. Enhancing Your Server with Express.js

While the built-in http module works, frameworks like Express.js simplify routing, middleware, and error handling.

Step 1: Install Express

In your project directory, run:

npm install express

Step 2: Create an Express Server

Replace the code in app.js with:

const express = require('express');
const app = express();
const PORT = 3000;

// Define a route
app.get('/', (req, res) => {
  res.send('Hello, Express Server!');
});

// Start the server
app.listen(PORT, () => {
  console.log(`Express server running at http://localhost:${PORT}/`);
});

Key Differences:

Simplified syntax for defining routes (e.g., app.get()).
Automatic handling of headers and content types.

Run the server again with node app.js and test the endpoint.

7. Debugging and Troubleshooting

Common Issues

Port Already in Use:
- Error: Error: listen EADDRINUSE: address already in use :::3000
- Fix: Terminate the existing process or change the port.
```
# Find and kill the process (Linux/macOS)
lsof -i :3000
kill -9 <PID>
```
Syntax Errors:
- Always check for typos or missing brackets in your code.
Missing Dependencies:
- Run npm install if you see Error: Cannot find module 'express'.

Using Nodemon for Auto-Restart

Install Nodemon to automatically reload the server during development:

npm install -g nodemon  # Install globally
nodemon app.js         # Start the server

8. Deploying Your Node.js Server

For production environments:

Set Environment Variables: Use dotenv to manage configurations:

npm install dotenv

Create a .env file:

PORT=4000

Update app.js:

require('dotenv').config();
const PORT = process.env.PORT || 3000;

Use a Process Manager: Tools like PM2 ensure your app restarts if it crashes:
```
npm install -g pm2
pm2 start app.js
```
Reverse Proxy with Nginx/Apache: Route traffic through Nginx for SSL termination and load balancing.

9. Conclusion and Next Steps

You’ve successfully set up Node.js, built a basic server, and enhanced it with Express.js. To expand your skills:

Explore routing, middleware, and templating engines (EJS, Pug).
Build RESTful APIs with databases like MongoDB or PostgreSQL.
Dive into frameworks like Nest.js or Fastify.

Node.js’s versatility and vast ecosystem make it a powerhouse for modern web development. Happy coding!

Further Resources

By following this guide, you’ve taken your first step into the world of server-side JavaScript. Experiment, break things, and keep learning! 🚀

Share on

Twitter Facebook LinkedIn

WackyDawg