Skip to content

Latest commit

 

History

History
111 lines (81 loc) · 5.92 KB

README.md

File metadata and controls

111 lines (81 loc) · 5.92 KB
Raw

JBot Build Status Codacy Javadocs Facebook Backers on Open Collective Sponsors on Open Collective MIT license

Make bots in Java.

JBot is a java framework (inspired by Howdyai's Botkit) to make Slack and Facebook bots in minutes. It provides all the boilerplate code needed so that you can make your bot live right away.

Why use JBot?

  • Provides you with all the boilerplate code which handles underlying websocket connections and other complexities.
  • Supports extra events in addition to all the events supported by Slack/Facebook which makes your work a lot more easier.
  • Receiving & sending messages is as easy as defining a @Controller and calling reply().
  • Conversation feature of JBot makes talking to your bot a breeze. This feature makes JBot different than rest of the Java frameworks out there.
  • Well tested with good coverage unit tests.
  • And many other features which can't just be mentioned here.

Not satisfied? Read on...

Still worried? Open an issue on Github and we can discuss.

JBot for Slack

Running your SlackBot is just 4 easy steps:

  1. Clone this project $ git clone [email protected]:rampatra/jbot.git.
  2. Create a slack bot and get your slack token.
  3. Paste the token in application.properties file.
  4. Run the example application by running JBotApplication in your IDE or via commandline: 
    $ cd jbot
$ mvn clean install
$ cd jbot-example
$ mvn spring-boot:run

You can now start talking with your bot ;)

Read the detailed Slack documentation to learn more.

JBot for Facebook

Similar to Slack, Facebook is simple too but has few extra steps:

  1. Clone this project $ git clone [email protected]:rampatra/jbot.git.
  2. Create a facebook app and a page.
  3. Generate a Page Access Token for the page (inside app's messenger settings).
  4. Paste the token created above in application.properties file.
  5. Run the example application by running JBotApplication in your IDE or via commandline: 
    $ cd jbot
$ mvn clean install
$ cd jbot-example
$ mvn spring-boot:run
  6. Setup webhook to receive messages and other events. You need to have a public address to setup webhook. You may use localtunnel.me to generate a public address if you're running locally on your machine.
  7. Specify the address created above in "Callback Url" field under "Webooks" setting and give the verify token as fb_token_for_jbot and click "Verify and Save".

You can now start messaging your bot by going to the facebook page and clicking on the "Send message" button.

If you're too lazy to start now and just want to play around, you can try jbot-example by visiting JBot facebook page and clicking on the "Send Message" button.

Read the detailed Facebook documentation to learn more.

Contributors

This project exists thanks to all the awesome people who contribute. If you want to flaunt your skills or make the project even better, you can start contributing and for any queries please just raise an issue and I would be more than happy to discuss :)

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

--
Happy Coding 🤖