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

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

![Product Name Screen Shot][product-screenshot]

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.

(back to top)

Getting Started

Prerequisites

Assuming you have python3 and pip installed (if not get them here or from your package manager), install the colorama package, it is used for changing text color.

• colorama

  pip3 install colorama

Installation & Usage

1. Clone the repo

   git clone https://github.com/michaelradu/python-cli-chat.git

2. Start the server

   python server.py

3. Start the client

   python client.py 

4. Enter a username of your choice
5. Start chatting

(back to top)

Roadmap

• [*] Basic Chat
• E2E encryption
• Internet chat
  • Multiple chat rooms

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the GNU GENERAL PUBLIC License. See LICENSE for more information.

(back to top)