bytepushers-js-restful
v0.0.9
Published
A Restful JavaScript APIs that handles transforming JSON data structure into domain driven JavaScript Models
Downloads
12
Readme
bytepushers-js-restful
Core Restful JavaScript framework.
Synopsis
Byte Pushers JavaScript Restful library that supports core restful features for processing RESTful response and request.
Code Example
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
Motivation
The motivation behind this project is to create a collection of common base functionality that can be extended and resused in larger projects.
Installation
Provide code examples and explanations of how to get the project.
API Reference
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Tests
Describe and show how to run the tests with code examples.
Contributors
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
License
A short snippet describing the license (MIT, Apache, etc.)
In order to build successfully, ensure the following:
- Use either minified version of modules or normal version of modules in the Gruntfile.js and Karma.conf.js files; but not both and not mixed matched.