Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kartikk221/hyper-express
High performance Node.js webserver with a simple-to-use API powered by uWebsockets.js under the hood.
https://github.com/kartikk221/hyper-express
express high-performance http http-server https https-server modular nodejs performance router server sessions uwebsockets uwebsocketsjs uws websocket
Last synced: 10 days ago
JSON representation
High performance Node.js webserver with a simple-to-use API powered by uWebsockets.js under the hood.
- Host: GitHub
- URL: https://github.com/kartikk221/hyper-express
- Owner: kartikk221
- License: mit
- Created: 2021-04-08T00:00:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T18:19:33.000Z (23 days ago)
- Last Synced: 2024-10-27T07:03:55.908Z (12 days ago)
- Topics: express, high-performance, http, http-server, https, https-server, modular, nodejs, performance, router, server, sessions, uwebsockets, uwebsocketsjs, uws, websocket
- Language: JavaScript
- Homepage:
- Size: 1.88 MB
- Stars: 1,766
- Watchers: 25
- Forks: 97
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - kartikk221/hyper-express - High performance Node.js webserver with a simple-to-use API powered by uWebsockets.js under the hood. (JavaScript)
- awesome-nodejs - hyper-express - High performance webserver with a simple-to-use API powered by uWebsockets.js under the hood.  (Repository / Web Frameworks)
README
# HyperExpress: High Performance Node.js Webserver
#### Powered by [`uWebSockets.js`](https://github.com/uNetworking/uWebSockets.js/)
[](https://www.npmjs.com/package/hyper-express)
[](https://www.npmjs.com/package/hyper-express)
[](https://github.com/kartikk221/hyper-express/issues)
[](https://github.com/kartikk221/hyper-express/stargazers)
[](https://github.com/kartikk221/hyper-express/blob/master/LICENSE)
## Motivation
HyperExpress aims to be a simple yet performant HTTP & Websocket Server. Combined with the power of uWebsockets.js, a Node.js binding of uSockets written in C++, HyperExpress allows developers to unlock higher throughput for their web applications with their existing hardware. This can allow many web applications to become much more performant on optimized data serving endpoints without having to scale hardware.
Some of the prominent highlights are:
- Simplified HTTP & Websocket API
- Server-Sent Events Support
- Multipart File Uploading Support
- Modular Routers & Middlewares Support
- Multiple Host/Domain Support Over SSL
- Limited Express.js API Compatibility Through Shared Methods/Properties
See [`> [Benchmarks]`](https://web-frameworks-benchmark.netlify.app/result?l=javascript) for **performance metrics** against other webservers in real world deployments.
## Documentation
HyperExpress **supports** the latest three LTS (Long-term Support) Node.js versions only and can be installed using Node Package Manager (`npm`).
```
npm i hyper-express
```
- See [`> [Examples & Snippets]`](./docs/Examples.md) for small and **easy-to-use snippets** with HyperExpress.
- See [`> [Server]`](./docs/Server.md) for creating a webserver and working with the **Server** component.
- See [`> [Router]`](./docs/Router.md) for working with the modular **Router** component.
- See [`> [Request]`](./docs/Request.md) for working with the **Request** component made available through handlers.
- See [`> [Response]`](./docs/Response.md) for working with the **Response** component made available through handlers.
- See [`> [Websocket]`](./docs/Websocket.md) for working with **Websockets** in HyperExpress.
- See [`> [Middlewares]`](./docs/Middlewares.md) for working with global and route-specific **Middlewares** in HyperExpress.
- See [`> [SSEventStream]`](./docs/SSEventStream.md) for working with **Server-Sent Events** based streaming in HyperExpress.
- See [`> [MultipartField]`](./docs/MultipartField.md) for working with multipart requests and **File Uploading** in HyperExpress.
- See [`> [SessionEngine]`](https://github.com/kartikk221/hyper-express-session) for working with cookie based web **Sessions** in HyperExpress.
- See [`> [LiveDirectory]`](./docs/LiveDirectory.md) for implementing **static file/asset** serving functionality into HyperExpress.
- See [`> [HostManager]`](./docs/HostManager.md) for supporting requests over **muliple hostnames** in HyperExpress.
## Encountering Problems?
- HyperExpress is mostly compatible with `Express` but not **100%** therefore you may encounter some middlewares not working out of the box. In this scenario, you must either write your own polyfill or omit the middleware to continue.
- The uWebsockets.js version header is disabled by default. You may opt-out of this behavior by setting an environment variable called `KEEP_UWS_HEADER` to a truthy value such as `1` or `true`.
- Still having problems? Open an [`> [Issue]`](https://github.com/kartikk221/hyper-express/issues) with details about what led up to the problem including error traces, route information etc etc.
## Testing Changes
To run HyperExpress functionality tests locally on your machine, you must follow the steps below.
1. Clone the HyperExpress repository to your machine.
2. Initialize and pull any submodule(s) which are used throughout the tests.
3. Run `npm install` in the root directory.
4. Run `npm install` in the `/tests` directory.
5. Run `npm test` to run all tests with your local changes.
## License
[MIT](./LICENSE)