periodicjs.ext.user_access_control/README.md

A user access control extension for Periodicjs that uses user roles and user privleges to controll access

# periodicjs.ext.user_access_control [![Coverage Status](https://coveralls.io/repos/github/githubUserOrgName/periodicjs.ext.user_access_control/badge.svg?branch=master)](https://coveralls.io/github/githubUserOrgName/periodicjs.ext.user_access_control?branch=master) [![Build Status](https://travis-ci.org/githubUserOrgName/periodicjs.ext.user_access_control.svg?branch=master)](https://travis-ci.org/githubUserOrgName/periodicjs.ext.user_access_control)

A simple extension.

[API Documentation](https://github.com/githubUserOrgName/periodicjs.ext.user_access_control/blob/master/doc/api.md)

## Usage

### CLI TASK

You can preform a task via CLI
```
$ cd path/to/application/root
### Using the CLI
$ periodicjs ext periodicjs.ext.user_access_control hello  
### Calling Manually
$ node index.js --cli --command --ext --name=periodicjs.ext.user_access_control --task=hello 
```

## Configuration

You can configure periodicjs.ext.user_access_control

### Default Configuration
```javascript
{
  settings: {
    defaults: true,
  },
  databases: {
  },
};
```


## Installation

### Installing the Extension

Install like any other extension, run `npm run install periodicjs.ext.user_access_control` from your periodic application root directory and then normally you would run `periodicjs addExtension periodicjs.ext.user_access_control`, but this extension does this in the post install npm script.
```
$ cd path/to/application/root
$ npm run install periodicjs.ext.user_access_control
$ periodicjs addExtension periodicjs.ext.user_access_control //this extension does this in the post install script
```
### Uninstalling the Extension

Run `npm run uninstall periodicjs.ext.user_access_control` from your periodic application root directory and then normally you would run `periodicjs removeExtension periodicjs.ext.user_access_control` but this extension handles this in the npm post uninstall script.
```
$ cd path/to/application/root
$ npm run uninstall periodicjs.ext.user_access_control
$ periodicjs removeExtension periodicjs.ext.user_access_control // 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