Perk

A well documented set of tools for building node web applications.

Description

The goal of Perk is first and foremost to provide a well documented set of tools for building node web applications. Perk also aims to get you up and running quickly, while still providing you the flexibility to build production ready node apps. With these goals in mind, Perk is built on top of a series of robust, well supported libraries that have stood the test of time: Passport, Express, Redis, and Knex. These libraries are not hidden from view. You're 100% in control to swap one out here or there if you find a better tool for the job.

Code Quality Rank: L5

Programming language: TypeScript

License: MIT License

Tags: Web Frameworks     Documentation     Framework     Web    

README

Perk

import { server } from "perk";

server({
    rootDirectory: __dirname,
    routes: {
        directory: "./routes",
        excludeRegex: ".*\\.test\\.ts$",
    },
    server: {
        url: "https://api.mywebsite.com",
        port: 3001,
        cors: {},
    },
})
    .then(() => {
        console.log(`Server started on port 3001`);
    })
    .catch((error: Error) => {
        console.error("The server couldn't start up...");
        console.error(error.message);
    });

process.once("SIGUSR2", async function () {
    process.kill(process.pid, "SIGUSR2");
});