periodicjs.ext.restful_api v1.4.2

periodicjs.ext.restful_api

Mount core datas via a restful api.

API Documentation

Usage

CLI TASK

You can preform a task via CLI

$ cd path/to/application/root
### Using the CLI
$ periodicjs ext periodicjs.ext.restful_api hello  
### Calling Manually
$ node index.js --cli --command --ext --name=periodicjs.ext.restful_api --task=hello 

Configuration

You can configure periodicjs.ext.restful_api

Default Configuration

{
  settings: {
    defaults: true,
  },
  databases: {
  },
};

Installation

Installing the Extension

Install like any other extension, run npm run install periodicjs.ext.restful_api from your periodic application root directory and then normally you would run periodicjs addExtension periodicjs.ext.restful_api, but this extension does this in the post install npm script.

$ cd path/to/application/root
$ npm run install periodicjs.ext.restful_api
$ periodicjs addExtension periodicjs.ext.restful_api //this extension does this in the post install script

Uninstalling the Extension

Run npm run uninstall periodicjs.ext.restful_api from your periodic application root directory and then normally you would run periodicjs removeExtension periodicjs.ext.restful_api but this extension handles this in the npm post uninstall script.

$ cd path/to/application/root
$ npm run uninstall periodicjs.ext.restful_api
$ periodicjs removeExtension periodicjs.ext.restful_api // this is handled in the npm postinstall script

Testing

Make sure you have grunt installed

$ npm install -g grunt-cli

Then run grunt test or npm test

$ grunt test && grunt coveralls #or locally $ npm test

For generating documentation

$ grunt doc
$ jsdoc2md commands/**/*.js config/**/*.js controllers/**/*.js  transforms/**/*.js utilities/**/*.js index.js > doc/api.md

Notes

• Check out https://github.com/typesettin/periodicjs for the full Periodic Documentation