https://github.com/michaelradu/python-cli-chat
CLI app that allows 2 or more people to connect to a chatroom and talk.
https://github.com/michaelradu/python-cli-chat
100daysofcode chat chatroom chatroom-application chatroom-client chatroom-server chatrooms cli cli-app pip python python3
Last synced: 2 months ago
JSON representation
CLI app that allows 2 or more people to connect to a chatroom and talk.
- Host: GitHub
- URL: https://github.com/michaelradu/python-cli-chat
- Owner: michaelradu
- License: gpl-3.0
- Created: 2022-04-16T17:22:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-16T18:34:44.000Z (about 3 years ago)
- Last Synced: 2025-01-29T14:15:47.324Z (4 months ago)
- Topics: 100daysofcode, chat, chatroom, chatroom-application, chatroom-client, chatroom-server, chatrooms, cli, cli-app, pip, python, python3
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Python CLI Chat
This is a CLI app that allows 2 or more people to connect to a chatroom and talk.
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://github.com/michaelradu/python-cli-chat)
This is a CLI app that allows 2 or more people to connect to a chatroom and talk. I built this in an afternoon for fun and learning purposes. Currently it only works with people on the same network as you, which is what I had in mind when I made it.
## Getting Started
### Prerequisites
Assuming you have python3 and pip installed (if not get them [here](https://www.python.org/downloads/) or from your package manager), install the colorama package, it is used for changing text color.
* colorama
```sh
pip3 install colorama
```
### Installation & Usage
1. Clone the repo
```sh
git clone https://github.com/michaelradu/python-cli-chat.git
```
2. Start the server
```sh
python server.py
```
3. Start the client
```sh
python client.py
```
4. Enter a username of your choice
4. Start chatting
## Roadmap
- [*] Basic Chat
- [ ] E2E encryption
- [ ] Internet chat
- [ ] Multiple chat rooms
See the [open issues](https://github.com/michaelradu/python-cli-chat/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the GNU GENERAL PUBLIC License. See `LICENSE` for more information.
[contributors-shield]: https://img.shields.io/github/contributors/michaelradu/python-cli-chat.svg?style=for-the-badge
[contributors-url]: https://github.com/michaelradu/python-cli-chat/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/michaelradu/python-cli-chat.svg?style=for-the-badge
[forks-url]: https://github.com/michaelradu/python-cli-chat/network/members
[stars-shield]: https://img.shields.io/github/stars/michaelradu/python-cli-chat.svg?style=for-the-badge
[stars-url]: https://github.com/michaelradu/python-cli-chat/stargazers
[issues-shield]: https://img.shields.io/github/issues/michaelradu/python-cli-chat.svg?style=for-the-badge
[issues-url]: https://github.com/michaelradu/python-cli-chat/issues
[license-shield]: https://img.shields.io/github/license/michaelradu/python-cli-chat.svg?style=for-the-badge
[license-url]: https://github.com/michaelradu/python-cli-chat/blob/master/LICENSE.txt