Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/santthosh/node-api-factory


https://github.com/santthosh/node-api-factory

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# node-api-factory [![Build Status](https://secure.travis-ci.org/santthosh/node-api-factory.png?branch=develop)](http://travis-ci.org/santthosh/node-api-factory)

Quick way to spec API with node.js

## Getting Started
1. Install the module with: `npm install node-api-factory` or add it to package.json

2. `require` node-api-factory in an js file as shown below, alternatively you can just run node-api-factory straight from install location

```javascript
/*
* main.js
*/
require('node-api-factory');
```

3. Run the api-factory `node main.js`

## Configuring api-factory
_(Coming soon)_

## Examples
_(Coming soon)_

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

## License
Copyright (c) 2013 Santthosh. Licensed under the MIT license.