https://github.com/phidlarkson/websockets-for-beginners

https://github.com/phidlarkson/websockets-for-beginners

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/phidlarkson/websockets-for-beginners
• Owner: PhidLarkson
• Created: 2024-04-04T17:19:29.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-04T20:56:47.000Z (9 months ago)
• Last Synced: 2024-11-08T16:23:22.877Z (2 months ago)
• Language: Python
• Size: 361 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# WebSockets Chat Demo

This is a simple demonstration of a chat application using WebSockets. It allows users to send and receive messages in real-time over a terminal.

## Appearance

![Chat Application Interface](screenshot/image.png)

The image above shows the interface of the chat application. It's a simple terminal-based interface where users can type their messages and see responses in real-time.

The chat is client to server for this repo

## Installation

I. To install this project, follow these steps:

    1. Ensure you have Python installed on your system. If not, download and install it from [here](https://www.python.org/downloads/).

    2. Install pip if it's not already installed. You can do this by running the following command:

        ```

        python get-pip.py

        ```

    3. Install virtualenv by running:

        ```

        pip install virtualenv

        ```

    4. Create a virtual environment in the project directory:

        ```

        virtualenv venv

        ```

    5. Activate the virtual environment:

        - On Windows, run:

            ```

            venv\Scripts\activate

            ```

        - On Unix or MacOS, run:

            ```

            source venv/bin/activate

            ```

II. Clone the repository:

    ```

    git clone https://github.com/phidlarkson/websockets-for-beginners.git

    ```

III. Navigate into the project directory:

    ```

    cd websockets-for-beginners

    ```

IV. Install the dependencies:

    ```

    python install -r requirements

    ```

## Usage

1. Start the server:

    ```

    python server.py

    ```

2. Open another terminal and start the client:

    ```

    python client.py

    ```

3. You can now start chatting by typing messages into the client terminal.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[MIT](https://choosealicense.com/licenses/mit/)