https://github.com/e2fyi/api-bot

NodeJS lib for handling various bot instructions.
https://github.com/e2fyi/api-bot

Last synced: 2 months ago
JSON representation

NodeJS lib for handling various bot instructions.

• Host: GitHub
• URL: https://github.com/e2fyi/api-bot
• Owner: e2fyi
• License: mit
• Created: 2017-10-18T05:15:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-22T11:38:17.000Z (over 7 years ago)
• Last Synced: 2025-02-17T11:03:55.786Z (3 months ago)
• Language: JavaScript
• Size: 400 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
api-bot

============

[![Build Status](https://travis-ci.org/e2fyi/api-bot.svg?branch=master)](https://travis-ci.org/e2fyi/api-bot)

[![Coverage Status](https://coveralls.io/repos/github/e2fyi/api-bot/badge.svg?branch=master)](https://coveralls.io/github/e2fyi/api-bot?branch=master)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

An `api-bot` is an customizable chat bot that can proxy with any APIs and

transform the results into a bot message. A JSON or YAML config file is used to

describe the both the interaction with the API and the transformation of the

output. The config file/doc can also easily be served via a noSQL database.

This is a NodeJS library to handle various instructions for an `api-bot`.

## Quick start

```

yarn add api-bot --save

```

## API reference

More details on the API can be found at the [Api-bot's jsDoc page](https://e2fyi.github.io/api-bot/index.html).