Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matheussc017/teamchat
This project consists of a chat application which is divided into two parts, the first is the server which is responsible for maintaining the chat structure (channels and subchannels) and establishing a communication point for connected users, the second part is the client, which is developed in Python.
https://github.com/matheussc017/teamchat
aiohttp assynchronous desktop mongodb pyqt6 python redis
Last synced: about 2 months ago
JSON representation
This project consists of a chat application which is divided into two parts, the first is the server which is responsible for maintaining the chat structure (channels and subchannels) and establishing a communication point for connected users, the second part is the client, which is developed in Python.
- Host: GitHub
- URL: https://github.com/matheussc017/teamchat
- Owner: MatheusSC017
- License: mit
- Created: 2024-04-07T12:04:46.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-15T00:00:17.000Z (5 months ago)
- Last Synced: 2024-08-15T01:55:54.461Z (5 months ago)
- Topics: aiohttp, assynchronous, desktop, mongodb, pyqt6, python, redis
- Language: Python
- Homepage:
- Size: 228 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TeamChat
This project consists of a chat application which is divided into two parts, the first is the server which is responsible for maintaining the chat structure (channels and subchannels) and establishing a communication point for connected users, the second part is the client, which is developed in Python, together with the PyQT library to create an interface in which the user can interact with the server structure and communicate with other users
## Characterist
### Users
Creating a user is very simple. You only need to set a username and a password. Optionally, you can also set an email and a nickname for auto-connecting in the chat.
### Chats
Chats have an owner and sub-channels. The owner is the user who creates and manages the channel. The sub-channels are the rooms where users can enter to chat.
Each sub-channel has several configurations:
Password: This configuration consists of two values:
A boolean indicating if the sub-channel is private or public.
If the sub-channel is private, the owner needs to specify a password.
User Limit: This configuration limits the number of users that can be connected to a specific sub-channel. You can set whether the sub-channel has a user limit, and if so, what that limit is.
Anonymous Users: This boolean setting indicates if the sub-channel accepts anonymous users or only logged-in users.
## Using
The first step to use the project is install the server, this can be done thought the few steps;
- Create virtual env
- Install dependencies of requirements.txt
- run app/main.py
Then you can start the client, create a .env file with the configuration, if you are running local this is an example of a configuration file, next time create a virtual environment, install the dependencies and run main.py
```
HOST=http://127.0.0.1
PORT=8080
SSL=0
```
## Create installer to desktop
Use the command below to create the chat client installer
```
pyinstaller main.py
```
or
```
pyinstaller --onefile main.py
```