/periodicjs.ext.reactapp

content management administration for a periodicjs based cms

Primary LanguageJavaScriptMIT LicenseMIT

periodicjs.ext.reactapp Coverage Status Build Status

A simple extension.

API Documentation

Usage

CLI TASK

You can preform a task via CLI

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

Configuration

You can configure periodicjs.ext.reactapp

Default Configuration

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

Installation

Installing the Extension

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

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

Uninstalling the Extension

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

$ cd path/to/application/root
$ npm run uninstall periodicjs.ext.reactapp
$ periodicjs removeExtension periodicjs.ext.reactapp // 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