Assuming you would like to serve a static site, single page application or just a static file (no matter if on your device or on the local network), this package is just the right choice for you.
Once it's time to push your site to production, we recommend using Vercel.
serve also provides a neat interface for listing the directory's contents:
The quickest way to get started is to just run
npx serve in your project's directory.
yarn global add serve
Once that's done, you can run this command inside your project's directory...
...or specify which folder you want to serve:
Finally, run this command to see a list of all available options:
Now you understand how the package works! 🎉
serve's behavior, create a
serve.json file in the public folder and insert any of these properties.
The core of
serve is serve-handler, which can be used as middleware in existing HTTP servers:
const handler = ;const http = ;const server = httpserver;
NOTE: You can also replace
http.createServer with micro, if you want.
- Fork this repository to your own GitHub account and then clone it to your local device
serveif it's already installed:
npm uninstall -g serve
- Link it to the global module directory:
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).