npmpackage.info

Gathering detailed insights and metrics for serve

Other packages similar to serve

serve-static

2.2.0

Serve static files

serve-index

1.9.1

Serve directory listings

@types/serve-static

1.15.8

TypeScript definitions for serve-static

@types/express-serve-static-core

5.0.7

TypeScript definitions for express-serve-static-core

Gathering detailed insights and metrics for serve

serve - 14.2.4 | npmpackage.info

serve

Static file serving and directory listing

14.2.4

9,664

MIT

TypeScript

25.24 kB

4.1

Installations

npm install serve

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>= 14

Node Version

18.20.4

NPM Version

10.7.0 Pull Requests

Open

13

Total

374

Closed

81

Merged

280

Issues

Open

127

Total

435

Closed

308

Releases

156

14.2.4

Updated on Oct 15, 2024

14.2.3

Updated on Apr 25, 2024

14.2.2

Updated on Apr 22, 2024

14.2.1

Updated on Aug 21, 2023

14.2.0

Updated on Jan 25, 2023

14.1.2

Updated on Nov 18, 2022

View All 156 releases

Languages

TypeScript

HTML

JavaScript

Shell

TypeScript (78.72%)

HTML (10.52%)

JavaScript (10.46%)

Shell (0.3%)

Developer

vercel

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

9,664 Stars

769 Commits

698 Forks

106 Watchers

5 Branches

164 Contributors

Updated on Jul 15, 2025

Maintainers

View All 164 Contributors

Package Meta Information

Latest Version

14.2.4

Package Id

serve@14.2.4

Unpacked Size

25.24 kB

Size

8.55 kB

File Count

NPM Version

10.7.0

Node Version

18.20.4

Published on

Oct 15, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

serve helps you serve a static site, single page application or just a static file (no matter if on your device or on the local network). It also provides a neat interface for listing the directory's contents:

Listing UI

Once it's time to push your site to production, we recommend using Vercel.

Usage

serve v14 onwards requires Node v14 to run. Please use serve v13 if you cannot upgrade to Node v14.

The quickest way to get started is to just run npx serve in your project's directory.

If you prefer, you can also install the package globally (you'll need at least Node LTS):

1> npm install --global serve

Once that's done, you can run this command inside your project's directory...

1> serve

...or specify which folder you want to serve:

1> serve folder-name/

Finally, run this command to see a list of all available options:

1> serve --help

Now you understand how the package works! :tada:

Configuration

To customize serve's behavior, create a serve.json file in the public folder and insert any of these properties.

API

The core of serve is serve-handler, which can be used as middleware in existing HTTP servers:

1const handler = require('serve-handler');
2const http = require('http');
3
4const server = http.createServer((request, response) => {
5  // You pass two more arguments for config and middleware
6  // More details here: https://github.com/vercel/serve-handler#options
7  return handler(request, response);
8});
9
10server.listen(3000, () => {
11  console.log('Running at http://localhost:3000');
12});

You can also replace http.createServer with micro.

Issues and Contributing

If you want a feature to be added, or wish to report a bug, please open an issue here.

If you wish to contribute to the project, please read the contributing guide first.

Credits

This project used to be called list and micro-list. But thanks to TJ Holowaychuk handing us the new name, it's now called serve (which is much more definite).

Author

Leo Lamprecht (@leo)

High

7.5/10

Summary

Path Traversal in serve

Affected Versions

< 7.0.0

Patched Versions

7.0.0

High

0/10

Summary

Cross-Site Scripting in serve

Affected Versions

< 10.0.2

Patched Versions

10.0.2

High

0/10

Summary

Path Traversal in serve

Affected Versions

< 10.1.2

Patched Versions

10.1.2

High

0/10

Summary

Byass due to validation before canonicalization in serve

Affected Versions

< 6.5.2

Patched Versions

6.5.2

High

7.5/10

Summary

Directory Traversal in serve

Affected Versions

< 7.1.3

Patched Versions

7.1.3

Moderate

5.3/10

Summary

vercel/serve allows access to restricted files if filename is URL encoded.

Affected Versions

< 6.5.2

Patched Versions

6.5.2

Moderate

0/10

Summary

Cross-Site Scripting in serve

Affected Versions

< 10.0.2

Patched Versions

10.0.2

Moderate

6.5/10

Summary

Directory Traversal in serve

Affected Versions

<= 6.4.8

Patched Versions

6.4.9

Moderate

5.3/10

Summary

Information Exposure on Case Insensitive File Systems in serve

Affected Versions

< 7.0.0

Patched Versions

7.0.0

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

6

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.1

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to serve

Other packages similar to serve

serve

Installations

Developer Guide

No

ESM

>= 14

18.20.4

10.7.0

Pull Requests

13

374

81

280

Issues

127

435

308

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Usage

Configuration

API

Issues and Contributing

Credits

Author

10

10

10

10

6

0

0

0

0

0

0

0

4.1

/10