https://github.com/sntakirutimana72/bluech
A chat app designed to handle multi users, threaded, and other complex forms of conversations. It supports media attachments, video & audio calls, text messages, and continuous notifications.
https://github.com/sntakirutimana72/bluech
asyncio kivy postgresql pypdf2 python-docx python3 socket
Last synced: 27 days ago
JSON representation
A chat app designed to handle multi users, threaded, and other complex forms of conversations. It supports media attachments, video & audio calls, text messages, and continuous notifications.
- Host: GitHub
- URL: https://github.com/sntakirutimana72/bluech
- Owner: sntakirutimana72
- License: mit
- Created: 2020-05-04T22:13:23.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-31T08:43:44.000Z (about 2 years ago)
- Last Synced: 2025-02-10T21:38:49.057Z (3 months ago)
- Topics: asyncio, kivy, postgresql, pypdf2, python-docx, python3, socket
- Language: Python
- Homepage:
- Size: 340 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bluech
**bluech** is a chat-app designed to handle multi users, threaded, and other complex forms of chatting.
The idea is to support media attachments, video & audio calls, text messages, and continuous notifications through its built-in push notification features.
Currently, it only supports text messaging and one-on-one single threaded user chat.
## Technologies
### Built with
- Python (v3.10)
- Postgres
### Tools & Methods
- Git
- GitHub
- Gitflow
- docker
# Get Started
To get started using this app, you must first
- Have a working computer with of `MS Windows 10` (or above) os.
- Install `PyCharm` IDE. You can install the latest version using this [link](https://www.jetbrains.com/pycharm/download).
- Install `python==3.10` in your local system. You can follow instructions found on this [website](https://www.python.org/downloads/release/python-3100/).
- Install `postgres` database with a user as `postgres` and password as `postgres`. ([download](https://www.postgresql.org/download/))
- Clone this project repo using this [link](../../).
- Start the app by running the below commands from the terminal:
- __For `non-docker` users__
```shell
$ cd
$ python -m pip install --no-cache-dir -r requirements.txt
$ python run.py
```
- __For `docker` users__
```shell
$ docker build -t bluech .
$ docker run bluech
$ docker ps
$ docker exec -it /bin/bash
$ service postgresql start
$ su postgres
$ psql
$ \password postgres;
$ \q
$ service postgresql reload
$ python3.10 run.py
```
### Tests
To run pre-defined test units, run the below from command line
+ __For `non-docker` users__
```shell
$ pytest -q --disable-warnings
OR
$ pytest --disable-warnings
```
+ __For `docker` users__
```shell
$ python3.10 -m pytest -q --disable-warnings
OR
$ python3.10 -m pytest --disable-warnings
```
`For further details, check the following spec documentations` [SERVER ENDPOINTS](SERVERSPECS.md) | [RELEASE NOTE](RELEASENOTE.md)
## Authors
👤 **Steve**
- GitHub: [@sntakirutimana72](https://github.com/sntakirutimana72/)
- LinkedIn: [steve-ntakirutimana](https://www.linkedin.com/in/steve-ntakirutimana/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Devs Communities for great free and resourceful articles.
## 📝 License
This project is [MIT](./LICENSE) licensed.