node-chat-stream v1.0.1

Node js Chat Stream

A NodeJS chat library build with socket.io and express js.This Package provide following types of chat:

1-User to user chat

2-User to multi-user chat

3-Group chat

Getting Started

Prerequisites

1-Nodejs
2-Express server
2-MongoDB
3-Socket Io version >= v2.3.0

Installation

1-Run

npm i node-chat-stream
//or
yarn add node-chat-stream 

2- Server side import and config:

import { SetChatConfig, StartChat } from ('node-chat-stream');
//(above for es6 ) or
const { SetChatConfig, StartChat } = require('node-chat-stream').NodeChatSteam;

ChatConfig({db_url: 'your_db_url'});  

StartChat(your_project_socket , express_server);

Client Side Flow

1-Install socket io
2-import and socket io config
3-Adde following event listener (also other basic event listner like reconnect ,disconnect)

socket.on("message", your_method/function);         
//  for user to user chat

socket.on("multi-user-message", your_method/function);
//  user to multi-user chat

socket.on("group-message", your_method/function);
//  group chat  

4-creat user with /chat-stream/users api

5-

socket.emit("sign-in", user);
//user created in step 4   

For sending messages example

socket.on("message", {text: 'text',sender: 'sender_id',receiver: 'receiver_id'});
//  for user to user  

socket.on("multi-user-message", {text: 'text',chat_list_id: 'chat_list_id',receiver: 'receiver_id'});
//  for user to multi-user 

socket.on("group-message", {text: 'text',sender: 'sender_id',receiver: 'receiver_id'});
//  for group  chat 

API Docmentation

https://documenter.getpostman.com/view/12181559/T1DqhdBV?version=latest

Built With

• Socket.IO - Realtime communication library
• Express - Web application framework for Node.js.
• MongoDB - NoSQL database

🤝 Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Show your support

Give a ⭐️ if this project helped you!

Acknowledgments

• Cooperative Computing