Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fwd/chatbot
NodeJS Chatbot Framework, configurable in JSON.
https://github.com/fwd/chatbot
chatbot chatbot-framework chatbots-framework nodejs open-source
Last synced: 4 days ago
JSON representation
NodeJS Chatbot Framework, configurable in JSON.
- Host: GitHub
- URL: https://github.com/fwd/chatbot
- Owner: fwd
- Created: 2021-08-24T20:39:12.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-09-05T21:31:09.000Z (about 2 years ago)
- Last Synced: 2023-12-13T14:14:47.636Z (11 months ago)
- Topics: chatbot, chatbot-framework, chatbots-framework, nodejs, open-source
- Language: JavaScript
- Homepage:
- Size: 342 KB
- Stars: 7
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
> Modular NodeJS Chatbot Framework
## Install
```sh
npm i @fwd/chatbot
```
## Express Example
```javascript
const chatbot = require('@fwd/chatbot')
const express = require('express')
const app = express()
const port = 3000
var answers = [
{
name: "Cookie",
confirmation: "Do you want a cookie?",
triggers: [ "cookie" ],
fields: [
{
label: "What flavor?",
name: "flavor"
},
],
action: async (fields) => {
console.log( fields.flavor )
return `🍪`
}
},
]
app.get('/', async (req, res) => {
if (!req.query.message) return res.send("Message is required.")
res.send( await chatbot('contextId', req.query.message, answers) )
})
app.listen(port, () => {
console.log(`Example app listening at http://localhost:${port}`)
})
```
### Terminal Chatbot 😎
```javascript
const chatbot = require('@fwd/chatbot')
const readline = require('readline');
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout
});
var answers = [
{
name: "Cookie",
confirmation: "Do you want a cookie?",
triggers: [ "cookie" ],
fields: [
{
label: "What flavor?",
name: "flavor"
},
],
action: async (fields) => {
console.log( fields )
return `🍪`
}
},
]
var recursiveAsyncReadLine = function () {
rl.question('> ', async (answer) => {
if (answer == 'exit') return rl.close()
if (answer == 'clear') return console.clear()
console.log( await chatbot('jenkins', answer, answers) )
recursiveAsyncReadLine();
});
};
recursiveAsyncReadLine();
```
## ❯ Contributing
Give a ⭐️ if this project helped you!
Contributions, issues and feature requests are welcome at [issues page](https://github.com/fwd/chatbot/issues).
## ❯ License
MIT License
Copyright © [@nano2dev](https://twitter.com/nano2dev).
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.
## ❯ Stargazers
[](https://github.com/fwd/chatbot)