https://github.com/gweltaz-calori/Pezzo

A blazing fast micro framework for node
https://github.com/gweltaz-calori/Pezzo

Last synced: about 1 month ago
JSON representation

A blazing fast micro framework for node

• Host: GitHub
• URL: https://github.com/gweltaz-calori/Pezzo
• Owner: gweltaz-calori
• Created: 2018-12-22T17:28:21.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-26T09:42:08.000Z (almost 6 years ago)
• Last Synced: 2024-05-10T16:32:46.991Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 72.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-blazingly-fast - Pezzo - A blazing fast micro framework for node (JavaScript)

README

        
# 💡 Pezzo

### A blazing fast nodejs micro framework to make rest api

Based on the http module

## Controllers

Pezzo use the same api than express

```js

const { Router } = require("../../../src/index");

const Controller = {

  getCats(req, res) {

    res.status(200).send([

      {

        name: "SuperCat"

      }

    ]);

  },

  getCat(req, res) {

    res.status(200).send({

      name: "Another cat"

    });

  }

};

new Router({ baseUrl: "/cats" })

  .get("/", Controller.getCats)

  .get("/:cat_id", Controller.getCat);

```

All controllers must be in the `/controller` directory

There is no need to import them they are all autoloaded

### Middlewares

You can define middleware, it works the same as express

```js

const isAdmin = true;

function isAdministrator(req, res, next) {

  if (isAdmin) {

    next();

  } else {

    res.status(401).send("Unauthorized");

  }

}

//Inside the controller

.get("/admin", Controller.getAdmin,[isAdministrator]);

```

### Form validation

You can easily validate incoming request body using validators

```js

const { validateBody } = require("../../../src/index");

const VALIDATION = {

  email: {

    required: "This field is required",

    isEmail: "Email invalid"

  },

  password: {

    required: "This field is required"

  }

};

//In the controller

.post("/login", Controller.login, [validateBody(VALIDATION)])

```

## Environnement

Pezzo uses mongodb and jwt by default

Define all your config variables inside the `.env` file

```env

APP_ENV=dev

APP_PORT=8081

JWT_SECRET=mysecret

MONGO_HOST=localhost

MONGO_PORT=27017

MONGO_DATABASE=myproject

```