anandrajB / scf-chat

CHAT APPLICATION

A Pluggable chat application

BUILD WITH FLASK==2.2.2 and MONGODB==5.0

Authors

• @Mohamed-Sheik-Ali
• @anandrajB

INSTALLATION AND RUNNING

1. pip install -r requirements.txt
2. gunicorn --bind 0.0.0.0:5000 wsgi:app
3. flask run

DATABASE

1. TESTING : Atlas
2. PRODUCTION : DIGITALOCEAN MONGODB_V5

URL

1. TESTING : https://scfchat.herokuapp.com
2. PRODUCTION : under construction

API Reference

Post a configuration - Admin only

  POST /config/create_config/

Parameter	Type	Description	Request
xpath	list	Required. list of Xpaths	json
url	URL field	Required. domain URL	json
label	URL field	Required. label for the xpath	json

Get a configuration

  GET /config/get_config/

Parameter	Type	Description	Request
domain_url	URL field	Required. domain URL	Query params

Post a conversation

    socket.io 
    event => "messages"

Parameter	Type	Description	Request
config_id	string	Required. Config reference	json
sender	email	Required. User	json
members	list	Required. members of a particular chat	json
party	string	Required. party name the members in the chat	json
text	string	Required. Message to be sent	json
subject	string	Required. Details processed from Xpath	json

Get conversation between users

     GET /conv/msgs/

Parameter	Type	Description	Request
members	list	Required. members of the chat	Query Params
config_id	string	Required. Config Reference	Query Params

Get conversation of the currently logged in user

     GET /conv/convo_list/

Parameter	Type	Description	Request
user	email	Required. currently logged in user	Query Params
config_id	string	Required. Config Reference	Query Params

Get the count of unread messages received by the user

     GET /count/count_msgs/

Parameter	Type	Description	Request
config_id	string	Required. Config Reference	Query Params

Update the is_read status of the messages

     GET /count/update_read/

Parameter	Type	Description	Request
config_id	string	Required. Config Reference	json
members	list	Required. members of the chat	json
is_read	boolean	Required. read status	json