Files
Zos/Skills/@be/node_modules/jibo-emotion-system/README.md

46 lines
1.5 KiB
Markdown

# jibo-emotion-system
[![Build Status](http://jenkins.jibo.com/buildStatus/icon?job=jibo-emotion-system)](http://jenkins.jibo.com/job/jibo-emotion-system/)
[Confluence Docs](https://confluence.jibo.com/display/CHAR/Jibo+Emotion+System)
[Usage docs](https://developers.jibo.com/internal-docs/api/latest/jibo.emotion.html)
## Development
Project source code supports both `*.js` files written in ES6 Javascript as well as `*.ts` files written in TypeScript.
Tests are written in ES6 with a `*.test.js` file ending
###Project structure
```
src/: All project source files
test/: All project test source files
lib/jibo-emotion-system.js
package.json: NPM Project dependencies
```
### Important: Plugins
This plugin builds typings slightly different from other skills.
Run `gulp dts` to build typings after building, before testing and pushing!
###Get Started
Run `yarn install` to get all dependencies
###Building
To build, run `yarn build`
###Testing
To run tests, `yarn test:debug`
## Usage Docs
Information on project and emotional architecture and overview can be found in the [Confluence Docs](https://confluence.jibo.com/display/CHAR/Jibo+Emotion+System)
Information on how to use the emotion system can be found in [API docs](https://developers.jibo.com/internal-docs/api/latest/jibo.emotion.html)
### Emotion Space Graph
<img width="734" alt="screen shot 2017-04-03 at 16 36 31" src="https://github.jibo.com/storage/user/28/files/8f0c57e8-192c-11e7-8a23-a629d0a6034c">