intro

Welcome in vchat sdk v1

Get started by creating a new app or existing app in production.

System Requirement

This is Not Full app

Directed to flutter developers who want to implement complete chat system in their apps without write chat code

Check Out YouTube tutorial YOUTUBE

1. login & register system in your app in v0.5.0 and above not required you can register by phone or ( facebook,apple,etc... just send the email) just send it in email no password needed
2. guest login also supported, but you can't start chat until you register

• I use passwordKeyHash to hash the email and sent it to server so passwordKeyHash so it must be same key in server .env and vChatController.init()

2. VPS Server for host node js and mongo db you can buy it from any provider like digital ocean or hostinger
3. last version of Flutter sdk run flutter upgrade
4. if any conflict happen update all your package to last version first or if not fixed please open issue on github

Why V_CHAT_SDK

• all data will save on your server you have bought to run v chat on it
• it has written in pure _dart_ help you to add chat functionality
• easy to integrate and support multi-language as you want also support widget customization
• Unlimited text/image/video/record message and notifications/group chat
• can be used with any existing or new flutter mobile project with any back-end service you use
• V_CHAT_SDK is an easy way to integrate advanced real time message chat with 6 public api only 👌
• V_CHAT_SDK use Node js as backend service and Firebase for (push notifications only) message database is Mongo DB
• Try the APK last version APK
• Try the IOS last version testflight

About Micro Service

1. less load on your main server since chat has high traffic.
2. They enable scale. Scalability is about more than the ability to handle more volume. It’s also about the effort involved. Microservices make it easier to identify scaling bottlenecks and then resolve those bottlenecks at a per-microservice level.
3. They are relatively easy to build and maintain. Their single-purpose design means they can be built and maintained by smaller teams. Each team can be cross-functional while also specialise in a subset of the microservices in a solution.
4. you can add it as subdomain like chat.example.com
5. there are public flutter package on pub.dev you have to use it as for flutter v_chat_sdk

How V_CHAT_SDK works

• VCHAT_SDK connected with your backend service HOW!.
• check out v chat api swagger to know more about how its apis works swagger
• VCHAT_SDK don't matter what is your backend code written because it will connect with it by public apis and run separately isolated but still connected by public apis
• When you register new user in your system you should call this public api

final u = await VChatController.instance.register(
  dto: VChatRegisterDto(
    name: name,
    userImage: imagePath == null ? null : File(imagePath!),
    email: email,
  ),
  context: context,
);

1. I just need basic information like unique id and password and your image to identify user in rooms view
2. email must be unique email is string you can pass phone number or anything
3. this api will save the user also in your node js database to use it later in chats
4. so when you want to start new chat just send me the peer email because it's unique in vchat and your system so I can identify the user same as login
5. v chat use access token and save it local it save login sections
6. so by this way the two systems are in sync
7. there are other public api like change name,chatImage will discuss in vchat_public_api
8. all chats and messages and files images videos saved on node js service on public folder
9. vchat use auth jwt token and rate limit for improve security
10. vchat automatic create thumbnail from use image to improve performance
11. vchat also create thumbnail from images which send in chat to improve the memory

Features

Name	Android	Ios
online/offline	👍	👍
textMessage/typing...	👍	👍
voiceRecord/recording...	👍	👍
saned video/file/images	👍	👍
cache all media	👍	👍
message notification	👍	👍
mute/un mute notification	👍	👍
block/un block users	👍	👍
message status/read/unread/and unread count	👍	👍
Group Chat with administration system	👍	👍
smooth performance	👍	👍