Chat gRPC

A chat application using gRPC to communicate between processes.

Demo • Documentation • Report Bug • Request Feature

📖 Table of Contents

• Introduction
  • What is gRPC?
  • Why gRPC?
• About the Project
  • Screenshots
  • Demo
  • Documentation
  • Features
• Getting Started
  • Prerequisites
  • How to use gRPC
  • Folder structure
  • Run Locally
• Command
• Like message rule
• Log
  • Log file
  • Content
• Roadmap
• Contributors
• Credits
• License

💫 Introduction

An application use gRPC to communicate between processes and allow users chat with each other.

What is gRPC?

gRPC (Google Remote Procedure Call) is an open-source, high-performance remote procedure call (RPC) framework developed by Google. It allows communication between client and server applications in a distributed system, enabling them to call methods or functions on remote systems as if they were local.

Key features of gRPC include: Language-agnostic, Protocol Buffers, Bi-directional Streaming, Strong Typing and Code Generation, Interoperability, Performance.

gRPC is widely used in various domains, including microservices architectures, cloud-native applications, and distributed systems. It simplifies the development of client-server communication, promotes code reusability, and enables the building of scalable and performant applications.

Why gRPC?

• Efficient Communication
• Language Agnostic
• Strong Typing and Code Generation
• Streaming and Real-Time Capabilities
• Performance and Scalability
• Extensibility and Interoperability

🌟 About the Project

📷 Screenshots

Figure 1: Welcome UI

Figure 2: Chatbox UI

Figure 3: App command

Figure 4: Server log

📽️ Demo

Check out the Demo video to see the app in action.

📰 Documentation

Check out the Documentation to see full report document.

Detail Documentation:

• Client documentation.
• Server documentation.
• Service documentation.

⭐ Features

• CLI interface
• Interact, customize command
• Server - Client
• Communication between processes - gRPC
• Voting - At least 2 other users LIKE the before msg to send new msg
• Log file

🧰 Getting Started

📌 Prerequisites

• Python: >= 3.10.7
• gRPC tools: gRPC compiler, Install here.

🦾 How to use gRPC

Step 1: Define your gRPC service using protocol buffers.

Refer to Service documentation for more information.

Step 2: Implement the server-side code for your gRPC service. This will handle incoming requests and provide responses. You can create a new process for each instance of your gRPC server.

Refer to Server documentation for more information.

Step 3: Implement the client-side code for your gRPC service. This will send requests to the server and receive responses. You can create one or more client processes as needed.

Refer to Client documentation for more information.

Step 4: Start the server process and client process(es).

📁 Folder structure

This project has the following file structure:

chat-grpc/                      # Root directory of the project
├── README.md                   # Markdown file with project information
├── LICENSE                     # File specifying the project's license
├── .gitignore                  # File specifying Git ignore patterns
├── assets/                     # Directory for project assets
│   ├── image1.png
│   ├── image2.png
│   └── image...
├── logs/                       # Directory for log files
│   └── logfile.log
├── utils/                      # Directory for utility files
│   ├── helper.png
│   └── logger.py
├── services/                   # Directory for service-related files
│   ├── proto/                  # Directory for protocol buffer definition files
│   │   ├── chat.proto
│   │   ├── share_type.proto
│   │   └── user.proto
│   ├── grpc_generated/         # Directory for generated gRPC files
│   │   ├── chat_pb2.py
│   │   ├── chat_pb2_grpc.py
│   │   ├── share_type_pb2.py
│   │   ├── share_type_pb2_grpc.py
│   │   ├── user_pb2.py
│   │   └── user_pb2_grpc.py
│   └── README.md
├── client/                     # Directory for client-related files
│   ├── _client.py
│   └── README.md
└── server/                     # Directory for server-related files
    ├── _server.py
    ├── services_class/         # Directory for service-specific classes
    │   ├── user_service.py
    │   └── chat_service.py
    └── README.md

🛠️ Run Locally

Install application

# Clone this repository
git clone https://github.com/QuanBlue/chat-grpc.git

# Go into the repository
cd chat-grpc

Run server

python3 ./server/_server.py

Run client (open new terminal)

python3 ./client/_client.py

Note: Run multiple client by using multiple terminal

💬 Command

We provide a CLI interface for the client. The CLI interface allows users to interact with the chat application with simple commands:

--like [user id]             like for user's message,
--name-len [limit length]    limit the length of the user name. Default is 10,
--frame-width [limit length]   limit the length of the frame. Default is 60,
--padding [limit length]     padding of the content in frame. Default is 2,
--history [limit length]     limit the number of messages in the chat history. Default is 9999,
--help                       show all commands with description,

🤖 Like message rule

LIKE reply: for allow user XX to continue chat (at least 2 LIKE)

Command: --like [user id]

Rule:

• Only LIKE once per user
• Can not LIKE your self

Example: --like 01

📄 Log

Log file

Syntax: <yyyy-mm-ddd hh-mm-ss> [TYPE] <content>

<!-- logs/logfile.log exapmle  -->

2023-06-27 09:32:31 [INFO] Server started on port 50051...
2023-06-27 09:32:35 [INFO] User[01]Quan created Successfully!
2023-06-27 09:32:38 [INFO] User[01] send message: hello
2023-06-27 09:32:38 [INFO] User[01] updated successfully!
2023-06-27 09:32:46 [ERROR] User[01] can not LIKE yourself!
2023-06-27 09:37:01 [ERROR] Getting user! User[adaw] not found!
2023-06-27 09:49:42 [ERROR] User[01] is BLOCKED to send message
2023-06-27 09:49:48 [INFO] User[02]Lien created Successfully!
2023-06-27 09:49:50 [INFO] User[01] updated successfully!
2023-06-27 09:49:50 [INFO] User[02] like for user[01]
2023-06-27 09:49:55 [ERROR] User[01] only LIKED: [01]'s message ONCE!
2023-06-27 09:50:42 [ERROR] User[01] can not LIKE yourself!
2023-06-27 09:51:05 [INFO] User[03]Dat created Successfully!
2023-06-27 09:49:50 [INFO] User[03] like for user[01]
2023-06-27 09:51:07 [INFO] User[01] updated successfully!
2023-06-27 09:51:07 [INFO] User[01] is ALLOWED to send message
...

Content

Server start success:

[INFO] Server started on port 50051...

Client connect and enter username:

[INFO] User[<user_id>]<username> created Successfully!
[ERROR] User[<user_id>]<username> created Fail!

Client send msg success:

[INFO] User[<user_id] send message: <message>

Update Client stat (like, block, allow):

[INFO] User[<user_id>] updated successfully!
[ERROR] Getting user! User[<user_id>] not found!

Client A like client B's msg:

[INFO] User[<userA_id>] like for User[<userB_id>]
[ERROR] User[<userA_id>] only LIKED: [<userB_id>]'s message ONCE!
[ERROR] User[<userA_id>] can not LIKE yourself!

The client is allowed/blocked to send messages:

[INFO] User[<user_id>] is ALLOWED to send message
[ERROR] User[<user_id>] is BLOCKED to send message

🗺️ Roadmap

• UI
• Command line - customize UI (padding, table width,...)
• Communication
• Logs
• Multi-threading (client)
• Chatting rule - At least 2 LIKE (from 2 others) to continue chat
• Demo
• Documentation

👥 Contributors

Contributions are always welcome!

✨ Credits

This software uses the following open source packages:

• gRPC
• Emojis are taken from here

📜 License

Distributed under the MIT License. See LICENSE for more information.

---

Bento @quanblue  ·  GitHub @QuanBlue  ·  Gmail [email protected]