97 lines
4.8 KiB
Markdown
97 lines
4.8 KiB
Markdown
|
# λ srvx
|
||
|
|
|
||
|
|
<!-- automd:badges color=yellow packagephobia -->
|
||
|
|
|
||
|
|
[](https://npmjs.com/package/srvx)
|
||
|
|
[](https://npm.chart.dev/srvx)
|
||
|
|
[](https://packagephobia.com/result?p=srvx)
|
||
|
|
|
||
|
|
<!-- /automd -->
|
||
|
|
|
||
|
|
Universal Server based on web standards. Works with [Deno](https://deno.com/), [Bun](https://bun.sh/) and [Node.js](https://nodejs.org/en).
|
||
|
|
|
||
|
|
- ✅ Zero dependency
|
||
|
|
- ✅ Full featured CLI with watcher, error handler, serve static and logger
|
||
|
|
- ✅ Seamless runtime integration with same API ([handler](https://srvx.h3.dev/guide/handler) and [instance](https://srvx.h3.dev/guide/server)).
|
||
|
|
- ✅ [Node.js compatibility](https://srvx.h3.dev/guide/node) with a [**close to native performance**](https://github.com/h3js/srvx/tree/main/test/bench-node).
|
||
|
|
- ✅ Zero overhead [Deno](https://deno.com/) and [Bun](https://bun.sh/) support.
|
||
|
|
|
||
|
|
## Quick start
|
||
|
|
|
||
|
|
```js
|
||
|
|
export default {
|
||
|
|
fetch(req: Request) {
|
||
|
|
return Response.json({ hello: "world!" });
|
||
|
|
},
|
||
|
|
};
|
||
|
|
```
|
||
|
|
|
||
|
|
Then, run the server using your favorite runtime:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Node.js
|
||
|
|
$ npx srvx # npm
|
||
|
|
$ pnpx srvx # pnpm
|
||
|
|
$ yarn dlx srvx # yarn
|
||
|
|
|
||
|
|
# Deno
|
||
|
|
$ deno -A npm:srvx
|
||
|
|
|
||
|
|
# Bun
|
||
|
|
$ bunx --bun srvx
|
||
|
|
```
|
||
|
|
|
||
|
|
👉 **Visit the 📖 [Documentation](https://srvx.h3.dev/) to learn more.**
|
||
|
|
|
||
|
|
## Starter Examples
|
||
|
|
|
||
|
|
[➤ Online Playground](https://stackblitz.com/fork/github/h3js/srvx/tree/main/examples/stackblitz?startScript=dev&file=server.mjs)
|
||
|
|
|
||
|
|
<!-- automd:examples -->
|
||
|
|
|
||
|
|
| Example | Source | Try |
|
||
|
|
| ---------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- |
|
||
|
|
| `elysia` | [examples/elysia](https://github.com/h3js/srvx/tree/main/examples/elysia/) | `npx giget gh:h3js/srvx/examples/elysia srvx-elysia` |
|
||
|
|
| `express` | [examples/express](https://github.com/h3js/srvx/tree/main/examples/express/) | `npx giget gh:h3js/srvx/examples/express srvx-express` |
|
||
|
|
| `fastify` | [examples/fastify](https://github.com/h3js/srvx/tree/main/examples/fastify/) | `npx giget gh:h3js/srvx/examples/fastify srvx-fastify` |
|
||
|
|
| `h3` | [examples/h3](https://github.com/h3js/srvx/tree/main/examples/h3/) | `npx giget gh:h3js/srvx/examples/h3 srvx-h3` |
|
||
|
|
| `hello-world` | [examples/hello-world](https://github.com/h3js/srvx/tree/main/examples/hello-world/) | `npx giget gh:h3js/srvx/examples/hello-world srvx-hello-world` |
|
||
|
|
| `hono` | [examples/hono](https://github.com/h3js/srvx/tree/main/examples/hono/) | `npx giget gh:h3js/srvx/examples/hono srvx-hono` |
|
||
|
|
| `jsx` | [examples/jsx](https://github.com/h3js/srvx/tree/main/examples/jsx/) | `npx giget gh:h3js/srvx/examples/jsx srvx-jsx` |
|
||
|
|
| `node-handler` | [examples/node-handler](https://github.com/h3js/srvx/tree/main/examples/node-handler/) | `npx giget gh:h3js/srvx/examples/node-handler srvx-node-handler` |
|
||
|
|
| `service-worker` | [examples/service-worker](https://github.com/h3js/srvx/tree/main/examples/service-worker/) | `npx giget gh:h3js/srvx/examples/service-worker srvx-service-worker` |
|
||
|
|
| `tracing` | [examples/tracing](https://github.com/h3js/srvx/tree/main/examples/tracing/) | `npx giget gh:h3js/srvx/examples/tracing srvx-tracing` |
|
||
|
|
| `websocket` | [examples/websocket](https://github.com/h3js/srvx/tree/main/examples/websocket/) | `npx giget gh:h3js/srvx/examples/websocket srvx-websocket` |
|
||
|
|
|
||
|
|
<!-- /automd -->
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
- Clone this repository
|
||
|
|
- Install the latest LTS version of [Node.js](https://nodejs.org/en/)
|
||
|
|
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
|
||
|
|
- Install dependencies using `pnpm install`
|
||
|
|
- **Prepare stub mode using `pnpm build --stub`**
|
||
|
|
- Run interactive tests using `pnpm dev`
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
<!-- automd:contributors author=pi0 license=MIT -->
|
||
|
|
|
||
|
|
Published under the [MIT](https://github.com/h3js/srvx/blob/main/LICENSE) license.
|
||
|
|
Made by [@pi0](https://github.com/pi0) and [community](https://github.com/h3js/srvx/graphs/contributors) 💛
|
||
|
|
<br><br>
|
||
|
|
<a href="https://github.com/h3js/srvx/graphs/contributors">
|
||
|
|
<img src="https://contrib.rocks/image?repo=h3js/srvx" />
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<!-- /automd -->
|
||
|
|
|
||
|
|
<!-- automd:with-automd -->
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
_🤖 auto updated with [automd](https://automd.unjs.io)_
|
||
|
|
|
||
|
|
<!-- /automd -->
|