npm package: @lykmapipo/role
Description: A representation on how a party(ies) acts or, in other words, what roles the party(ies) plays in specific context or environment.
Latest version: 0.3.34

# role

[![Build Status](https://travis-ci.org/lykmapipo/role.svg?branch=master)](https://travis-ci.org/lykmapipo/role)
[![Dependencies Status](https://david-dm.org/lykmapipo/role/status.svg?style=flat-square)](https://david-dm.org/lykmapipo/role)
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/lykmapipo/role/tree/master)

A representation on how a party(ies) acts or, in other words, what roles the party(ies) plays in specific context or environment.

It defines set of permissions(or access rights) that are applicable to to a specific party(ies).

[Demo](https://rolle.herokuapp.com/v1/roles)

## Requirements

- [nodejs v8.11.1+](https://nodejs.org)
- [npm v5.6.0+](https://www.npmjs.com/)
- [MongoDB v3.4.10+](https://www.mongodb.com/)
- [mongoose v5.2.5+](https://github.com/Automattic/mongoose)

## Installation

```sh
npm install @lykmapipo/role --save
```

## Usage

```js
const mongoose = require('mongoose');
const { app } = require('@lykmapipo/role');

//connect to mongodb
mongoose.connect(process.env.MONGODB_URI);

//fire the app
app.start((error, env) => {
  ...
});
```

## Demo
[View Demo](https://rolle.herokuapp.com/v1/roles)
[View apidoc](https://lykmapipo.github.io/role/)

## Testing

- Clone this repository

- Install all development dependencies

```sh
npm install
```

- Run example

```sh
npm run dev
```

- Then run test

```sh
npm test
```

## Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

## References
- [A Universal Person and Organization Data Model](http://tdan.com/a-universal-person-and-organization-data-model/5014)
- [popolo project](https://www.popoloproject.com/)
- [Open Civic Data](http://docs.opencivicdata.org/en/latest/index.html)

## Licence

The MIT License (MIT)

Copyright (c) 2018 lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.