Code Monkey home page Code Monkey logo

mm4s-examples's Introduction

mm4s-examples

Sample implementations of mm4s

Basic Instructions for running a bot

  1. Package your bot into Docker image
  2. Deploy Mattermost
  3. Deploy Dockerbot
  4. Use Dockerbot REST API to deploy your bot

Math Bot

Example of a well behaved bot that can do some basic math.

Initiate conversation with @math

See the help with @math help

Command format (lhs operation rhs) Four supported operations

  • + addition
  • - subtraction
  • * multiplication
  • / division

Consul Bot

Get Tweets Bot

An example file results being posted by a bot.

Should identify the capability of this pattern as a developer tool for fetching sample data.

Status Bot

Example of tracking and reporting of job status.

Initiate conversation with @statusbot

Command formats

  • mock X start task that runs for X seconds, returns task id
  • check id check completion status of id, return % of completion
  • isdone id check completion status of id, returns boolean completion

Proxy Bot

Example of a bot acting as a pass-through for a third party ws consumer.

To test this example.

  1. Start Mattermost using the mmm4s Docker Compose, login with admin and open Off-Topic
  2. Run mm4s.examples.proxy.ProxyBotBoot4dev
  3. Connect to ws://localhost:8081/ws/test using a third party WS util (eg Dark WebSocket)
  4. Enter messages into both the WS util and the MM view and notice the flow between them

Chained Bots (todo)

Example of bot jobs together by sending result a to job b

Bugs and Feedback

For bugs, questions and discussions please use the Github Issues.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

mm4s-examples's People

Contributors

jw3 avatar

Watchers

James Cloos avatar  avatar

mm4s-examples's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.