Static file serving and directory listing
Ever wanted to share a certain directory on your network by running just a command? Then this module is exactly what you're looking for: It provides a neat interface for listing the directory's contents and switching into sub folders.
In addition, it's also awesome when it comes to serving static sites. If a directory contains an
serve will automatically render it instead of serving the file's content as plaintext.
Install it (needs at least Node LTS):
npm install -g serve
And run this command in your terminal:
serve <path> [options]
Run this command to see a list of all available options:
If you set the
--auth flag, the package will look for a username and password in the
SERVE_PASSWORD environment variables.
As an example, this is how such a command could look like:
SERVE_USER=leo SERVE_PASSWORD=1234 serve --auth
You can also use the package inside your application. Just load it:
const serve =
And call it with flags (run this command for the full list):
const server =
Later in the code, you can stop the server using this method:
serveif it's already installed:
npm uninstall -g serve
After that, you can use the
serve command everywhere. Here's a list of issues that are great for beginners.
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).