1.0.0 • Published 7 years ago

shin-gimel v1.0.0

Weekly downloads
1
License
MIT
Repository
-
Last release
7 years ago

Shin Gimel

Shin Gimel is an API gateway based on nodejs and redis.

Note: This project is still in POC state.

How does it works?

Preety simple just include the module like

const shinGimel = require('shin-gimel')

And then then run it with the right config dirctory

const gateway = shinGimel(`${__dirname}/config`)

The config folder should contain this folder strcture

config
 |-config.json (General settings for Gateway)
 |-endpoints (Will contain json or js files for each endpoint)
    |-base.json (Not requierd, will be used as base for the other endpoints)
    |-api1-name.json (One for each endpoint)
    |-api2-name.js (Or .js file that exports hash)

Run the example

In order to run the example use the commend

npm run run-example