Complete Guide to Running a Node.js Application¶

This guide covers all necessary steps to run a Node.js application, from installation to testing and deployment. It includes commands for setting up the environment, running the application, and troubleshooting.

Table of Contents¶

1. Prerequisites
2. Setting Up the Environment
3. Running the Application
4. Testing the Application
5. Troubleshooting Tips
6. Additional Best Practices

Prerequisites¶

Before starting, ensure the following:

• Node.js and npm (Node Package Manager) are installed.
• Basic knowledge of JavaScript and web development.
• Access to a terminal or command prompt.

Setting Up the Environment¶

1. Install Node.js and npm¶

Install Node.js and npm on your system using the following commands:

# Update package lists
sudo apt update

# Install Node.js and npm
sudo apt install -y nodejs npm

# Verify installation
node -v   # Outputs the Node.js version
npm -v    # Outputs the npm version

2. Prepare the Project Directory¶

Navigate to your project folder or clone it from a Git repository:

# Clone the project repository
git clone <repository-url>

# Navigate to the project folder
cd <project-folder>

Running the Application¶

Step 1: Install Dependencies¶

Install the necessary dependencies for your application using npm:

npm install

If your project is divided into client and server subdirectories:

# Install client dependencies
cd client
npm install --omit=dev   # Skips dev dependencies for production

# Install server dependencies
cd ../server
npm install --omit=dev

Step 2: Start the Application¶

Run the application using the following commands:

For simple applications:

node app.js

If the application uses npm scripts:

npm start

Step 3: Access the Application¶

After starting the server, access the application in your web browser:

http://localhost:3000

Replace 3000 with the port your application is configured to run on (if different).

Testing the Application¶

1. Using Postman¶

Open Postman.

Create HTTP requests (GET, POST, PUT, DELETE) to test your API endpoints.

Example: Send a POST request to http://localhost:3000/api/example.

2. Using cURL¶

Send requests directly from the terminal using cURL:

# Example GET request
curl http://localhost:3000/api/example

# Example POST request
curl -X POST -H "Content-Type: application/json" -d '{"key":"value"}' http://localhost:3000/api/example

Troubleshooting Tips¶

Error: Port Already in Use¶

Stop any existing application running on the same port.

Change the port in your application settings or use the following command to kill the process:

sudo kill -9 $(lsof -t -i:3000)

Missing Dev Dependencies¶

If you encounter errors related to missing one specific dev module, reinstall dependencies:

npm install <package-name> --save-dev # In recent npm versions, --save-dev is optional

Environment Variables¶

Ensure .env files are correctly set up for the development or production environment.

Example:

PORT=3000
DATABASE_URL=mongodb://localhost:27017/mydb

Syntax or Runtime Errors¶

Use debugging tools or logs to identify issues. Run the application in debug mode:

node --inspect app.js

Additional Best Practices¶

Version Control¶

Use Git for version control and commit changes frequently:

git init
git add .
git commit -m "Initial commit"

Linting and Formatting¶

Use tools like ESLint or Prettier to maintain code quality:

npm install eslint --save-dev
npx eslint --init

Testing¶

Add automated tests for your application:

Use testing frameworks like Jest or Mocha.

Example Jest installation:

npm install jest --save-dev
npx jest

Production Setup¶

Use a process manager like PM2 to manage the application in production:

npm install pm2 -g
pm2 start app.js

Ensure the application is running behind a reverse proxy like Nginx.

Static File Serving¶

For front-end applications, ensure static files are properly served using middleware like express.static.