Skip to content

broidHQ/broidhq.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

npm node deps tests bithound bithoundscore nsp-checked

Broid

Broid Integrations is an open source project providing a suite of Activity Streams 2 libraries for unified communications among a vast number of communication platforms.

Connect your App to Multiple Messaging Channels with One OpenSource Language.


Broid.ai

[![gitter](https://badges.gitter.im/broidHQ/broid.svg)](https://t.broid.ai/c/Blwjlw?utm_source=github&utm_medium=readme&utm_campaign=top&link=gitter)

Install

npm install --save broid-<your-messaging-plateform>

Introduction

Broid Integrations provide a suite of librairies to convert all messagings plateforms events to Activity Streams 2 schemas.

TL;DR

  • All events are Observables (RxJS)
  • All functions return Promise (Bluebird)
  • Highly modular and low level to keep your focus on hight level features.

Get Started

Check out Broid's quick Get Started guide.

Integrations

Broid Integrations support simple, media and rich messages (location, carroussel) and split into multiple librairies. This make Broid flexible and usefull to use in your application.

Node packages

Name Status
broid-slack viber slack slack
broid-viber viber viber viber
broid-twitter viber twitter twitter
broid-line line line line
broid-messenger messenger messenger messenger
broid-callr callr callr callr
broid-discord discord discord discord
broid-skype skype skype skype
broid-telegram telegram telegram telegram
broid-twilio twilio twilio twilio
broid-flowdock flowdock flowdock flowdock
broid-kik kik kik kik
broid-irc irc irc irc
broid-gitter gitter gitter gitter
broid-google-assistant google-assistant google-assistant google-assistant
broid-nexmo nexmo nexmo nexmo
broid-groupme groupme groupme groupme
broid-alexa alexa alexa alexa

Broid Formats

Broid integrations supports Activity Streams 2.0 and uses broid-schemas package to validate input and output message.

Name Status
broid-schemas schemas schemas schemas

Contributing

If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.

If you create a integrations, please consider open sourcing it, putting it on npm, following the broid-<xxxx> convention as a name and create an issue on Github to inform the community.

You are also welcome to correct any spelling mistakes or any language issues.

If you want to discuss something or just need help, here is our Gitter room.

Code of Conduct

Make sure that you're read and understand the Code of Conduct.

CLA

To protect the interests of the Broid contributors, Broid, customers and end users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is simple and straightforward - it requires that the contributions you make to any Broid open source project are properly licensed and that you have the legal authority to make those changes. This helps us significantly reduce future legal risk for everyone involved. It's easy---no faxing or printing required!

You can digitally sign the CLA online. Please indicate your email address in your first pull request so that we can make sure that will locate your CLA. Once you've submitted it, you no longer need to send one for subsequent submissions.

Contributors

Broid contributors Broid contributors

About

Connect your App to Multiple Messaging Channels with One OpenSource Language.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published