A framework to write fast web services in easy way. Designed for developers, QAs, Maintainers, and BAs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
benchmark
docs
src
static
tasks
tests
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
package-lock.json
package.json
yarn.lock

README.md

मुनीम (Muneem)

Simple and fast web framework designed not only for developers but QAs, Maintainers, BAs, and DevOps.

Muneem Logo

मुनीम (Muneem) is the web framework developed in nodejs. It is designed with the aim of easy & rapid development, small learning curve, distributed development, fast services, proper documentation, easy bug discovery and providing the best solution not only for developers but all the team members.

Your contribution will help us to grow fast

Usages

Install

$ npm i muneem --save

Example

const muneem = Muneem();

muneem.add(...);

muneem.start();

Muneem allows to add routes and request handlers from the code as well as from the file system.

Routes added using yaml mapping files are readable and can be understood and managed by non-developers;

#Scenario: this is the sample route
- route: 
    uri: /some/url
    when: POST
    to: requestHandler
    after: [ "authentication", "monitoring", "cache out"]
    then: [ "compress it" , "cache in"]

Similarly request handlers added from filesystem hides the detail of framework configuration from the user. Eg

profile.js

//@handler
var getProfileDetail = async (asked, answer, store) => {
    await asked.readXml();
    var profileDetail = store("db")( buildQuery(asked.body.profileId) );
    answer.writeXml(profileDetail);
}

//..

module.exports = getProfileDetail;

Documentation

  • Introduction: registering routes, adding resources to store, server configuration, https, http2, limiting request length.
  • Routes: request mapping with request-handlers, sequence of handlers, environment specific routes, unnamed handlers, limiting request length etc.
  • Request Handler: Adding handlers from code, and from files.
    • HttpAsked: A wrapper around native http request object.
    • HttpAnswer: A wrapper around native http response object.
  • Events: Adding before/after events, and pre/post handlers, Handling errors, default routs, and large requests using events.
  • Writing Middleware or Plugins: How a plugin can be written. What are the things can be done by a plugin.
  • Available Plugins: body parsers, serializers, compression etc.