lyfeyaj/poplar

View on GitHub
README.md

Summary

Maintainability
Test Coverage
Poplar (白杨树)
==============

[![Build Status](https://travis-ci.org/poplarjs/poplar.svg?branch=master)](https://travis-ci.org/poplarjs/poplar)
[![Code Climate](https://codeclimate.com/github/lyfeyaj/poplar/badges/gpa.svg)](https://codeclimate.com/github/lyfeyaj/poplar)
[![npm version](https://badge.fury.io/js/poplar.svg)](http://badge.fury.io/js/poplar)
[![Inline docs](http://inch-ci.org/github/lyfeyaj/poplar.svg?branch=master)](http://inch-ci.org/github/lyfeyaj/poplar)
[![Join the chat at https://gitter.im/lyfeyaj/poplar](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lyfeyaj/poplar?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

> Under active development

Poplar (https://github.com/poplarjs/poplar) is an easy to use and opinionated micro-framework built on top of [express](https://github.com/strongloop/express) for writing scalable and REST-like web APIs. Its main goals are parameter validation, entities, hooks, scalability and allowing rapid development and deployment of such APIs.

Because of this Poplar is an ideal candidate for building robust, scalable and secure web things.

Features
--------
* Websocket support
* Built-in parameter validation
* Entities - a simple Facade to use with your models and API
* Hooks, enabling the power of scalability of your api method

License
-------
* Poplar is licensed under the MIT license

TODOs
-----

* Add upload files support
* Add beforeValidation hook
* Add socket.io support
* Add koa support