Code Monkey home page Code Monkey logo

susi_gitterbot's Introduction

Getting Started : Gitter Susi AI Bot Installation

Create a github or twitter account. Now you need to sign in to Gitter with a twitter or github account from here.

We will be using the streaming API of Gitter to deploy SUSI chat bot to Gitter. You can read the documentation and get familiar with the API.

Deploy to Docker Cloud

Prerequisites

To create your account on -:

  1. Github
  2. Gitter
  3. Heroku

SUSI.AI Gitter messenger bot

Feel free to play around with the already built SUSI.AI bot on Gitter. This room will reply to the queries when mentioned with "@susiai". So we can try asking SUSI.AI our queries, for example - @susiai BTC to INR here.

Setup your own Messenger Bot

  1. Fork this repository.

  2. Create your community by visiting this page. After writing your community name press next, invite the people you want to be in this room and press next. You will be redirected to your communities lobby. This lobby is the chat room to which we will deploy our SUSI AI.

  3. Now visit the gitter developer page, press sign in on the top right. You will be redirected to your apps page. Copy the personal access token written there.

  4. On a new tab, in your browser visit https://api.gitter.im/v1/rooms?access_token=YOUR_ACCESS_TOKEN, with YOUR_ACCESS_TOKEN replaced by the token we just copied. A JSON object will be shown on our browser screen. You will see the value of 'name' key as YOUR_COMMUNITY_NAME/Lobby. Copy the id of this chat room, as we will need it later. You can refer to the image below, you will have your chat room id in the area coloured black.

alt text

  1. Create a new heroku app here.

This app will accept the requests from Gitter and Susi api.

alt text

  1. Connect the heroku app to the forked repository.

Connect the app to Github

alt text

  1. Set the config variables for this heroku app in the setting tab of your account. Set ROOM_ID to the id of the chat room and TOKEN to the personal access token.

alt text

  1. Deploy on development branch. If you intend to contribute, it is recommended to Enable Automatic Deploys.

Branch Deployment.

alt text

Successful Deployment.

alt text

  1. Go to the your Gitter room created and enjoy chatting with Susi.

alt text

susi_gitterbot's People

Contributors

aliayub007 avatar manveer695 avatar orbiter avatar bhaveshan avatar mariobehling avatar hkedia321 avatar

Stargazers

Osama Zaid avatar Partik Singh avatar Anne Thorpe avatar Akash avatar Pavan Sriram Kannuri avatar Harini_B avatar Harshita Deep avatar Yathaarth Sharma avatar Nitin Hariharan avatar Saksham Gupta avatar Rushi Kotak avatar Yagyesh Bobde avatar Ankush Singh avatar Kishar Kr Nath avatar Darshan Nere avatar Deeksha Dewangan avatar avatar Pranshu Jain avatar Jaivardhan Shukla avatar Diya James avatar Jai Bhardwaj avatar Adarsh Gupta avatar Bilal Aamer avatar Vinayak Sankar avatar Aamir Ali avatar Stuck avatar avatar Kirtika Gautam avatar R Veda shree avatar Dev Nev avatar J. Akash Kumar Reddy avatar ThatOneKrish avatar (0*9)[9] avatar Mihir Kumar Singh avatar Asif Khan avatar avatar Nilabja Sarkar avatar Sandesh Verma avatar Kistappagari Sanketh Kumar avatar Graham avatar avatar Ashi Gautam avatar Devanshu Saxena avatar Shi (Brandon) Bai avatar Ina avatar Adarsh Mishra avatar Sumit avatar Gurleen Kaur avatar Love Tewari avatar Priyansh Jhalora avatar Jyotirmay avatar Jaspreet Singh avatar Raghav Kumar avatar Saurav Kumar avatar Ishita Kapoor avatar Amarjargal avatar Shashank Kashyap Vijay Kumar Pandey avatar Nithin avatar Shamik avatar Neel Shah avatar Neel Raval avatar Sophiya Singh avatar Gul Jain avatar jatin choudhary avatar Ekansh Agarwal avatar Pranjal Choudhary avatar ibli avatar Devansh Mudgal avatar Rohith Raju avatar Anshuman Singh avatar Shamitha avatar Moazzam Moriani avatar Anushka Gupta avatar Ravi Kanth Gojur avatar Chaitanya Agarwal avatar SATYAM KUMAR avatar Jay Thadeshwar avatar Shama Devi avatar Manish Swami avatar Abhay Mittal avatar Somya Agrawal avatar Adarsh kumar singh avatar MANDAR DILIP GAJBHIYE avatar Shiva smaran avatar Anirban Sinha avatar Kunwar Prabal avatar Niharika Dhulipala avatar Aayush Kumar Singh avatar Divyansh Raj avatar Abhineash Kishan avatar Shatanik Mahanty avatar Samarth Khatri avatar SAURAV RAJ avatar Anudeep Nagulapally avatar Devansh Tiwari avatar Priya Mittal avatar Archisman Das avatar Souvik Das avatar avatar avatar

Watchers

avatar James Cloos avatar avatar Hong Phuc Dang avatar Sudheesh Singanamalla avatar Saptak Sengupta avatar Akshat Garg avatar avatar avatar avatar

Forkers

manveer695 aliayub007 radhikadua123 collinx rmcoder198 rishav159 samiullahd vishwajeetsinh98 luphieanza thatdns hkedia321 simran1 debck akshatnitd unitedrpms-devel apheliongroup mysticaltech madilraza emonmeena mobasherah12 12-malak

susi_gitterbot's Issues

Set default SUSI response

Actual behaviour
Sometimes, when the SUSI server sends no response, the bot also fails.
Expected behaviour
Set a default response for such cases.
Would you like to work on it?
Yes.

Reformat table response

I'm submitting a ...

  • bug report
  • feature request

Current behavior:
The table response is in simple text.
Expected behavior:
Reformat the table response using github markdown.

Would you like to work on it?
Yes.

Bug in updating deployment image on each commit

Actual Behaviour

Currently, there is a bug due to which updates are not being pushed to kubernetes deployment.

Expected Behaviour

Deployment image should be updated

Would you like to work on the issue?

Yes

Remove SUSI's mention from the message dynamically

current behaviour:
The SUSI username is assumed to be 6 characters long and is removed accordingly.
Expected behaviour:
The SUSI username should be removed dynamically after getting the username from the gitter API.
*would you like to work on it?
Yes.

Make SUSI bot work with any username

Current behaviour:
the bot works only when the message starts with "@susiai".
Actual behaviour:
the bot should work when the user deploys the bot with some other username also like @mysusi. Extract the username from github API instead of hardcoding it.
Would you like to work on it?
Yes.

Make a UI for easy deployment of SUSI gitterbot

I'm submitting a ...

  • bug report
  • feature request

Current behavior:
No UI for deploying the SUSI gitterbot to heroku.

Expected behavior:
A UI should be made to ease the process of deploying the gitterbot to heroku and installing it in your channel.

Would you like to work on it?
Yes.

Update readme and deploy in new testing room.

Current behavior:
The readme is outdated and the gitter room for testing susi gitterbot is no longer working.

Expected behavior:
Update the readme. Deploy the gitterbot in new room and update the link

Would you like to work on it?
Yes.

Set .env file

Current behaviour:
No .env file is there. We cannot use environment variables from this file.
Expected behaviour:
We should be able to set environment variables by setting a .env file.
Would you like to work on it?
Yes.

Loop through the actions array

Current behaviour
Currently, the action types are matched based on their index and only one of them is executed.
Actual behaviour
A for loop should be used to loop through the actions.
Would you like to work on it?
Yes.

Show image instead of a link

I'm submitting a ...

  • bug report
  • feature request

Current behavior:
When an image type of response comes from the server, only the link is displayed.

Expected behavior:
Image should be shown in the github markdown instead of just the link

Would you like to work on it?
Yes.

Table and search type output not shown properly.

When a user makes a query like "universities in india", no answer is shown and for a query which is answered by search results, the answer is not shown properly.

Screenshot of the issue:
issuegitteruni

Would you like to work on this issue?
Yes, working on it.

Add functionality for "/help" command

I'm submitting a ...

  • feature request

Current behavior:
No help option available for the user

Expected behavior:
User should be able to get the required general information about SUSI like what can it do by asking for /help.

Would you like to work on it?
Yes.

Add package-lock.json and .gitignore

Actual Behaviour

Currently, package-lock.json is not committed.

Expected Behaviour

package-lock.json should be committed. See here https://stackoverflow.com/questions/44206782/do-i-commit-the-package-lock-json-file-created-by-npm-5#answer-44210813

 package-lock.json is automatically generated for any operations where npm modifies either the node_modules tree, or package.json. It describes the exact tree that was generated, such that subsequent installs are able to generate identical trees, regardless of intermediate dependency updates.

Yes I would like to work on this issue.

Table type of response is not working

I'm submitting a ...

  • bug report
  • feature request

Current behavior:
Table type of response is not working as expected:
image
Also the app is crashing sometimes.

Expected behavior:
Table type of response should work.

Would you like to work on it?
Yes.

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.