periodicjs.ext.passport

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.passport hello  
### Calling Manually
$ node index.js --cli --command --ext --name=periodicjs.ext.passport --task=hello 

Configuration

You can configure periodicjs.ext.passport

Default Configuration

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

Installation

Installing the Extension

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

$ cd path/to/application/root
$ npm run install periodicjs.ext.passport
$ periodicjs addExtension periodicjs.ext.passport // this is handled by npm post install script

Uninstalling the Extension

Run npm run uninstall periodicjs.ext.passport from your periodic application root directory and then normally you would run periodicjs removeExtension periodicjs.ext.passport but this is handled by the npm post install script.

$ cd path/to/application/root
$ npm run uninstall periodicjs.ext.passport
$ periodicjs removeExtension periodicjs.ext.passport // this is handled by npm post uninstall 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

Todo

• re-add user creation validation
• re-add welcome email
• re-add forgot password
• re-add activation
• re-add social login
• re-add two factor
• re-add reset password

Notes

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