Building a Real-Time Chat App with PyQt5, WebSockets, and MongoDB 🚀

Building desktop applications that communicate in real-time is always exciting! 💬 Recently, I completed a project where I created a cross-platform chat application using PyQt5 for the GUI, Socket.IO for real-time communication, and MongoDB Atlas for message storage. I also deployed the server on Render.com and created Linux and Windows executables for easy distribution. Here's my journey and the technologies I used. 👨‍💻

---

Overview of the Project ✨

The application allows multiple users to chat in real-time, including:

• Public messages: Everyone sees these 🌍

• Private messages: Users can select a recipient from the user list 🔒

• Typing indicators: Shows when someone is typing ⌨️

• Message history: Loads the last 100 messages from the database 📚

• Color-coded usernames: Each user gets a unique color 🎨

The project combines desktop GUI development, backend development, and real-time networking

---

Technologies Used 🛠️

Here's the stack I used for this project:

• Frontend/Desktop:

  • PyQt5 – Python library for building native desktop applications with GUI 🖥️

• Backend/Server:

  • Python + aiohttp – To run the async web server 🐍

  • python-socketio[aiohttp] – For real-time communication between clients and server ⚡

  • MongoDB Atlas – Cloud database to store chat messages ☁️

• Additional Python libraries:

  • dnspython – Required for MongoDB connection string parsing 🔗

  • pymongo – For interacting with MongoDB 🗄️

• Deployment:

  • Render.com – For hosting the async Python server in the cloud 🚀

• Packaging:

  • PyInstaller - Created executables for Windows and Linux so users can run the app without Python installed 📦

---

How the App Works 🔄

1. User Registration: 👤 Users enter a username in a simple login dialog. Each username is assigned a unique color.

2. Real-Time Messaging: 💬 Messages are sent using Socket.IO. The server broadcasts messages to everyone or only to a selected recipient for private messages.

3. Typing Indicators: ⌨️ When a user types, the typing event is sent to other clients to show real-time typing notifications.

4. Message History: 📜 On connecting, the client fetches the last 100 messages from MongoDB Atlas and displays them with date separators.

5. User List and Colors: 🎨 The server maintains a user list and unique color mapping and sends updates whenever users connect or disconnect.

---

Challenges & Learnings 🧠

• Threading with PyQt5: 🔄 Updating the GUI from socket callbacks required signals and slots to avoid threading issues.

• Real-time performance: ⚡ Handling typing indicators and private messages without lag was tricky but fun! 😅

• MongoDB Date Handling: 📅 Storing timestamps in UTC and formatting them on the client side ensured correct display across time zones.

• Cross-platform builds: 🖥️ Packaging PyQt5 apps for Linux and Windows using PyInstaller required careful testing of dependencies.

---

Project Structure 📁

Based on my actual project structure:

PyQt_Chat_with_MongoDB/
├── client.py                 # Main client application
├── server.py                # Socket.IO server with MongoDB
├── message_bubble.py        # Custom message widget
├── chat.ui                  # Qt Designer UI file
├── requirements.txt         # Python dependencies
├── client.spec             # PyInstaller spec file
├── README.md               # Project documentation
├── build/                  # PyInstaller build directory
├── dist/                   # Output executables
├── __pycache__/            # Python cache files
└── venv/                   # Virtual environment

• client.py – Main PyQt5 GUI application 🖥️

• server.py – Async Socket.IO server with MongoDB integration 🔌

• message_bubble.py – Custom widget for chat bubbles 💬

• chat.ui – Qt Designer interface file 🎨

• requirements.txt – All required Python libraries 📋

• client.spec – PyInstaller configuration for packaging 📦

---

Deployment & Release 🚀

• The server is deployed on Render.com: https://pyqt-chat-with-mongodb.onrender.com ☁️

• The client executables for Linux and Windows are available in the v1.0 Pre-release: PyQt Chat v1.0 Release 📦

📥 Download Links:

• Linux: PyQtChat_Linux (75 MB)

• Windows: PyQtChat_Windows.exe (40.7 MB)

Users can download and start chatting without installing Python 🎉

---

Key Takeaways 💡

• Real-time apps are easier with WebSockets than polling ⚡

• PyQt5 is robust for building professional desktop applications 🖥️

• MongoDB Atlas makes cloud database integration seamless ☁️

• Signals and slots are essential when updating the GUI from background threads 🔄

• Packaging and cross-platform distribution are as important as coding the app itself 📦

---

Technologies Summary 📊

---

Final Thoughts 🤔

This project was a great way to learn and apply WebSockets, PyQt5 GUI development, and cloud database integration!

The application is now available as v1.0 pre-release with standalone executables for both Linux and Windows, making it accessible to users 🎉

---

💡 Future Enhancements: You can extend this app with file sharing 📁, emoji support 😊, or message reactions ❤️ in the future!

---

🎉 Happy coding! Feel free to check out the repository and contribute! 👇

Star the repo ⭐ if you find this project interesting!

Connect with me

• GitHub

• LinkedIn