wudu-server

v0.2.35

Published

8 months ago

NodeJS backend framework to make things easier

0High
0Medium
0Low

md5login

NodeJS Backend Framework Server

Welcome to wudu-server

This is a lightweight backend framework for NodeJS.

Pros

ES6
Modular
Convenient approach to backend logic and flow
Impact on performance: close to none!
Plug-n-play: no dependencies required
No compilers, transpilers or processors - WYSIWYG

Cons

Requires basic understanding of backend programming

Benchmark

Machine: Windows 10 Pro 10.0.18363 Build 18363, Intel(R) Core(TM) i9-7900X CPU @ 3.30GHz, 3301 Mhz, 10 Core(s), 20 Logical Processor(s), 64GB RAM
Method: autocannon -c 100 -d 40 -p 10 http://localhost:3000/ (best avg score in 3 runs)
Node: 15.3.0
Run: Sun Jan 24 2021 14:12:10

Benchmark setup

Comparing to leading frameworks with routing on the market (by corresponding setups):

| Framework | Version | Requests/s | Latency | Throughput/MB | |----------- |---------|------------|----------|---------------| | wudu-server | 0.2.9 | 48101.6 | 20.49 | 8.27| | fastify | 3.10.1 | 43312.2 | 22.6 | 8.1| | express | 4.17.1 | 12856.2 | 77.24 | 2.4|

Prerequisites

NodeJS >= 15.3.0
NPM

Installation

npm i wudu-server

Create Simple Server

Suggested project structure

Project directory
 ├ client
 |  ┖ index.html
 ├ server
 |  ┖ endpoints
 |     ┖ IndexEndpoint.js
 ┕ index.js

Code

index.js

import { App, Router, Server } from 'wudu-server';
import IndexEndpoint from "./src/server/endpoints/IndexEndpoint.js";

// create new application
let app = new App();

// assign router to your app
app.router = Router.handler;

// add endpoint to your router
Router.addEndpoints(IndexEndpoint);

// run your app as a server
app.runServer({
    protocol: Server.HTTP,
    port: 80
});

server/endpoints/IndexEndpoint.js

export default class IndexEndpoint {
    static ['GET /'] (req, res) {
        res.file('./client/index.html', {ifModifiedSince: req.headers['if-modified-since']});
    }
}

client/index.html

<!DOCTYPE html>
<html>
<head></head>
<body>Hello, world!</body>
</html>

HTTPS

You can start an HTTPS server by replacing the corresponding code in index.js by the following:

// run your app as a server
app.runServer({
    protocol: Server.HTTPS,
    port: 443,
    options: { // corresponds to native NodeJS https config
        key: fs.readFileSync('PATH_TO_KEY'),
        cert: fs.readFileSync('PATH_TO_CERT'),
        ...
    }
});

Run

node index.js

CHANGELOG

DOCUMENTATION

Bugs and Issues

Feel free to open bugs, issues or suggest improvements here.