tell-me-about

Bot that explains to people important terms (such as famous people and place), that they find while reading news.

Inspiration

Kigali Times Entertainment is a Rwanda based news website. We write news about sports and celebrities, So people who read our news usually have to google names of players mentioned in the article being read. They do this because they do not know these players and are interested in knowing more about them. Therefore, we are building a bot that would tell them a little more about these players.

Currently, the bot can be accessed through our Facebook page

Moreover, it is limited in terms interaction (i.e. users must type the full question who is Didier Drogba?), so we hope to take advantage of the power of Lex, so that the bot can understand users no matter what they type!.

Development

Basic

Download the code git clone https://github.com/kgltimes/tell-me-about.git
Install dependancies npm install
Build the deployable code npm run build
Run tests npm test

Detailed information

The system is a AWS lambda function
We use Typescript as the coding language
We use Rollup as the build system (Babel plugins)
We use jest for testing

Compile Typescript code to ES6, then transpile ES6 code to ES5. ES5 is stored in a bin folder

I recomend looking through the package.json to understand each command

Deployment

We use Claudiajs to ease the deploayment process
Replace AWS profile name with the correct one inside package.json or just use the command below bash # on mac ox export AWS_PROFILE=<profile-name>
Deploy the lambda function by typing npm run create

[travis-image]: https://travis-ci.org/kgltimes/tell-me-about.svg?branch=master [travis-url]: https://travis-ci.org/kgltimes/tell-me-about

[dependency-image]: https://gemnasium.com/badges/github.com/kgltimes/tell-me-about.svg?style=flat [dependency-url]: https://gemnasium.com/github.com/kgltimes/tell-me-about

[climate-image]: https://codeclimate.com/github/kgltimes/tell-me-about/badges/gpa.svg [climate-url]: https://codeclimate.com/github/kgltimes/tell-me-about

[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat [license-url]: LICENSE