nitro README

The project's README from github.com/nitrojs/nitro. As one markdown file: README.md.

Ask DeepWiki

Nitro

[!NOTE] You’re viewing the v3 branch. For the current stable release, see Nitro v2.

Nitro extends your Vite app with a production-ready server, designed to run anywhere. Add server routes, deploy across multiple platforms, and enjoy a zero-config experience.

📘 Docs: https://nitro.build

Contributing

Check out the Contribution Guide to get started.

License

Released under the MIT License.

nitro (nitrojs/nitro)

Searching Database…

11.3K ·GitHub
What is this?Nitro is a server toolkit that extends your Vite app with a production-ready server you can add routes to and deploy anywhere.
Is this a standalone server or something I plug into my app?Nitro is not a standalone server app; it plugs into an existing Vite project and turns it into a deployable server by letting you add server routes on top of your app.
How do I add Nitro to my project?You add Nitro into a Vite app and start defining server routes; the exact plugin setup and route API are covered in the official docs linked from the README.
Do I need an existing Vite app and a specific Node version?Yes, Nitro is built to extend Vite apps, and it requires Node.js ^20.19.0 or >=22.12.0 according to the package engines field.
Is the current branch stable enough to use in production?The default branch is Nitro v3, which is still under active development; the README points users who need stability to Nitro v2 as the current stable release.
What does Nitro mean by 'zero-config' server experience?Nitro bundles core server pieces like HTTP handling (h3), routing (rou3) and caching (ocache) out of the box, so you get a working production server without wiring these pieces together yourself.
Does Nitro support WebSockets?Yes, Nitro includes the crossws library as a dependency, giving it built-in cross-runtime WebSocket support alongside its HTTP server layer.
Why does Nitro depend on packages like db0 and unenv?db0 gives Nitro a lightweight database connector and unenv provides environment polyfills, which together let the same Nitro server code run consistently across Node, edge and serverless runtimes.
What are similar projects?hono, beego, hapi, fastify, graphql, react-starter-kit, gofr, carno.js
Creator
nitrojs
Size
27.8 MB
Stars
11.3K
Age
4y
Commits · 90 Days