https://github.com/ciscodevnet/essentials

🔮 Essential packages to build, release, and run great software in the cloud - bots, cards, containers, analytics and more!
https://github.com/ciscodevnet/essentials

bot docker es6 eslint framework javascript library nodejs

Last synced: about 16 hours ago
JSON representation

🔮 Essential packages to build, release, and run great software in the cloud - bots, cards, containers, analytics and more!

• Host: GitHub
• URL: https://github.com/ciscodevnet/essentials
• Owner: CiscoDevNet
• License: other
• Created: 2021-04-06T08:23:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-16T17:36:44.000Z (6 months ago)
• Last Synced: 2024-11-13T17:39:53.628Z (3 days ago)
• Topics: bot, docker, es6, eslint, framework, javascript, library, nodejs
• Language: JavaScript
• Homepage: https://ciscodevnet.github.io/essentials/
• Size: 16.9 MB
• Stars: 7
• Watchers: 15
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Essentials

Essential packages to build, release, and run great software.

- Create intelligent bots with [Adaptive Cards](https://adaptivecards.io/)

- Gather and send analytics

- Deploy Docker containers to [Google Cloud](https://cloud.google.com/) or [OpenShift](https://www.openshift.com/)

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.4-4baaaa.svg)](code_of_conduct.md)

## Example

```js

// Create a Webex bot with Botkit.

const { Botkit } = require("botkit");

const { WebexAdapter } = require("botbuilder-adapter-webex");

const adapter = new WebexAdapter({

  access_token: "",

  public_address: "",

  secret: "",

});

const controller = new Botkit({

  adapter,

  webhook_uri: "/api/messages",

});

// Use the product analytics middleware. 👇

const { Analytics } = require("@cisco/bot-middleware");

const analyticsMiddleware = new Analytics("");

controller.middleware.receive.use(analyticsMiddleware.trackUserMessage);

controller.middleware.send.use(analyticsMiddleware.trackBotMessage);

```

Now basic properties from all messages are automatically ✨ sent to analytics, including:

- message ID

- message time

- sender's domain, e.g., cisco.com

- if the conversation is one-on-one or in a group

- more!

## Installation

Clone this repository.

Install its dependencies with [npm](https://www.npmjs.com/).

```bash

cd essentials

npm ci

```

Bootstrap the project with [Lerna](https://github.com/lerna/lerna).

```bash

npx lerna bootstrap

```

## License

[Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)