About this project

serve is a command-line tool developed by Vercel that simplifies serving static websites, single-page applications, and individual files from your local machine or local network. It provides a clean directory listing interface for browsing file contents. Getting started is straightforward: run `npx serve` in your project directory, or install it globally with `npm install --global serve`. You can specify a particular folder to serve or view all available options with `serve --help`. Configuration is handled through a `serve.json` file placed in the public folder, allowing customization of serving behavior. The core functionality is powered by `serve-handler`, which can also be integrated as middleware into existing HTTP servers using Node.js or micro. The tool requires Node.js v14 or later for versions 14 and above. It was previously known as `list` and `micro-list` before being renamed to `serve`. The project is authored by Leo Lamprecht and is open-source, welcoming contributions and issue reports.