Serving static files in Node.js - Mini Project: Build & Apply

Serving Static Files with Node.js

📖 Scenario: You are building a simple Node.js server to serve static files like HTML, CSS, and images for a small website.

🎯 Goal: Build a Node.js server that serves static files from a folder called public using the express framework.

📋 What You'll Learn

Create an Express app instance

Set up a static file serving middleware for the public folder

Start the server listening on port 3000

Verify that files in public are accessible via the browser

💡 Why This Matters

🌍 Real World

Serving static files is a common need for websites to deliver HTML, CSS, JavaScript, and images to users.

💼 Career

Understanding how to serve static files with Node.js and Express is essential for backend web development roles.

1

Create Express app

Write code to import express and create an Express app instance called app.

Node.js

// Your code here to import express and create app

Hint

Use import express from 'express' and then const app = express().

2

Configure static file serving

Add a line to use Express static middleware to serve files from the public folder using app.use(express.static('public')).

Node.js

import express from 'express';
const app = express();

// Add static middleware to serve 'public' folder

Hint

Use app.use(express.static('public')) to serve static files.

3

Start the server

Write code to start the server listening on port 3000 using app.listen(3000).

Node.js

import express from 'express';
const app = express();

app.use(express.static('public'));

// Start server on port 3000

Hint

Use app.listen(3000) to start the server.

4

Add a simple HTML file in public folder

Create a file named index.html inside the public folder with a simple HTML structure containing a heading <h1>Welcome</h1>.

Node.js

// Create 'public/index.html' file with Welcome inside

Hint

Create a file public/index.html with a heading <h1>Welcome</h1>.

Practice

1. What is the main purpose of using express.static in a Node.js server?

easy

A. To manage user authentication

B. To handle database connections

C. To create dynamic HTML pages

D. To serve static files like images, CSS, and JavaScript to users

Solution

1. Step 1: Understand the role of express.static

   This middleware is designed to serve files such as images, CSS, and JavaScript directly to the browser.

2. Step 2: Compare with other server tasks

   Database connections, dynamic page creation, and authentication are handled by other parts of the server, not express.static.

3. Final Answer:

   To serve static files like images, CSS, and JavaScript to users -> Option D

4. Quick Check:

   Serving static files = A [OK]

Hint: Remember: static files are served by express.static middleware [OK]

Common Mistakes:

• Confusing static file serving with database handling
• Thinking express.static creates dynamic content
• Assuming express.static manages user login

2. Which of the following is the correct syntax to serve static files from a folder named public using Express?

easy

A. app.static('public')

B. app.use(express.static('public'))

C. express.use.static('public')

D. app.getStatic('public')

Solution

1. Step 1: Recall Express static middleware syntax

   The correct way is to call app.use(express.static('folderName')) to serve static files.

2. Step 2: Check each option

   Only app.use(express.static('public')) uses the correct method and syntax. Others are invalid or do not exist in Express.

3. Final Answer:

   app.use(express.static('public')) -> Option B

4. Quick Check:

   Correct static serving syntax = B [OK]

Hint: Use app.use with express.static and folder name [OK]

Common Mistakes:

• Using app.static instead of app.use(express.static)
• Calling express.use.static which is invalid
• Trying app.getStatic which does not exist

3. Given this Express code snippet:

const express = require('express');
const app = express();
app.use(express.static('assets'));
app.listen(3000);

What URL path would serve the file assets/logo.png?

medium

A. http://localhost:3000/assets/logo.png

B. http://localhost:3000/public/logo.png

C. http://localhost:3000/logo.png

D. http://localhost:3000/static/logo.png

Solution

1. Step 1: Understand express.static path mapping

   When serving static files from folder 'assets', the files are accessible at the root URL path, so 'logo.png' is at '/logo.png'.

2. Step 2: Analyze each URL option

   http://localhost:3000/logo.png matches the correct URL path. Options A, B, and C incorrectly add folder names to the URL path.

3. Final Answer:

   http://localhost:3000/logo.png -> Option C

4. Quick Check:

   Static folder files appear at root URL path = D [OK]

Hint: Static folder files appear at root URL unless a prefix is set [OK]

Common Mistakes:

• Adding folder name to URL path incorrectly
• Assuming static files need /static or /public prefix
• Confusing folder name with URL path

4. Identify the error in this code snippet that tries to serve static files from the static folder:

const express = require('express');
const app = express();
app.use(express.static.static('static'));
app.listen(3000);

medium

A. Incorrect use of express.static.static instead of express.static

B. Missing app.listen call

C. Folder name should be absolute path

D. Static files folder must be named 'public'

Solution

1. Step 1: Check the express.static usage

   The code incorrectly calls express.static.static. The correct call is express.static.

2. Step 2: Verify other parts

   App.listen is present, folder name can be relative, and folder name does not have to be 'public'.

3. Final Answer:

   Incorrect use of express.static.static instead of express.static -> Option A

4. Quick Check:

   Use express.static, not express.static.static [OK]

Hint: Use express.static, not express.static.static [OK]

Common Mistakes:

• Adding extra .static after express.static
• Thinking folder must be named 'public'
• Believing folder path must be absolute

5. You want to serve static files from the public folder but under the URL path prefix /static. Which code correctly achieves this?

hard

A. app.use('/static', express.static('public'))

B. app.use(express.static('/static/public'))

C. app.use('/public', express.static('static'))

D. app.get('/static', express.static('public'))

Solution

1. Step 1: Understand URL prefix with express.static

   To serve static files under a URL prefix, pass the prefix as the first argument to app.use, then the static middleware.

2. Step 2: Evaluate each option

   app.use('/static', express.static('public')) correctly uses app.use('/static', express.static('public')). Others either misuse paths or methods.

3. Final Answer:

   app.use('/static', express.static('public')) -> Option A

4. Quick Check:

   URL prefix with app.use('/prefix', express.static(folder)) = A [OK]

Hint: Use app.use('/prefix', express.static('folder')) for URL prefix [OK]

Common Mistakes:

• Putting URL prefix inside express.static argument
• Using app.get instead of app.use for static files
• Mixing folder and URL prefix names