https://github.com/houshmand-2005/chat_app
A WebSocket-based chat application built with FastAPI
https://github.com/houshmand-2005/chat_app
chatroom websocket websocket-chat
Last synced: 6 months ago
JSON representation
A WebSocket-based chat application built with FastAPI
- Host: GitHub
- URL: https://github.com/houshmand-2005/chat_app
- Owner: houshmand-2005
- License: mit
- Created: 2023-10-28T11:42:40.000Z (over 2 years ago)
- Default Branch: houshmand
- Last Pushed: 2024-02-26T13:59:29.000Z (over 2 years ago)
- Last Synced: 2024-02-26T15:05:58.486Z (over 2 years ago)
- Topics: chatroom, websocket, websocket-chat
- Language: Python
- Homepage:
- Size: 1 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Chat App
A WebSocket-based chat application built with FastAPI
## Table of Contents
- [Overview](#overview)
- [How It Works](#how-it-works)
- [Features](#features)
- [How to run it?](#how-to-run)
- [Samples](#samples)
- [ToDo](#todo)
# Overview
This project is a WebSocket chat application created using FastAPI. It allows users to chat with others [**asynchronously**](https://stackoverflow.com/questions/748175/asynchronous-vs-synchronous-execution-what-is-the-difference) in **real-time**, **join groups**, **send** and **receive messages**, and more.
FrontEnd Connect to websocket and api with raw JavaScript and for styling uses bootstrap and css
## How It Works
By sending information with WebSockets, user can receive unread and new messages and send messages and also receive text changes such as edit and delete.
Also broadcast 'changes' and 'Send Message' are similar to this
you can see how change broadcast work (Codes have been shortened for display. See here for full codes: websocket.py)
```python
async def broadcast_changes(
group_id: int,
message_id: int,
new_text: str | None = None,
change_type: models.ChangeType,
db: Session,
) -> None:
...
online_users = set(websocket_connections.keys())
await asyncio.gather(
*[
send_change_to_user(
member.user.id, changed_value, online_users=online_users
)
for member in group.members
]
)
async def send_change_to_user(
user_id: int, change_data: dict, online_users: set
) -> None:
...
await connection.send_text(json.dumps(change_data))
```
### Features
- **Real-time WebSocket** chat
- Written as **async**
- User **authentication** and **authorization**
- Group **creation** and **management**
- **Sending** and **receiving** messages
- **Editing** and **deleting** messages
# How to run?
we need to get three docker images
- 1.**Python** to run BackEnd and [Uvicorn](https://www.uvicorn.org/)
- 2.**Nginx** to run FrontEnd
- 3.**Postgres** to run DataBase
```bash
# clone the project
git clone https://github.com/houshmand-2005/chat_app
# go to the folder
cd chat_app
# run project with docker
docker-compose up -d
```
# Samples
This is list of available APIs:
# ToDo
These are the things I want to do
- Add validation (like email validation username validation and ...)
- Make schemas with [Pydantic](https://pydantic.dev/) for each model(now it is a little incomplete and some models don't have it)
- Make FrontEnd more beautiful and make it more clear (This will probably be hard. I'm not very good at css and html😁)
- Support sending photos and files
- Support replay on message
- Add a cache service for handel unread messages and more (Like **redis**)