Metadata-Version: 2.1
Name: udp_chat
Version: 0.1
Summary: UDP-based chat application
Home-page: https://github.com/ErikPolzin/udp-chat
Author: Ohio Imevbore, Luke Slater, Erik Polzin
License: MIT
Description: # Asynchronous UDP-based chat application
        
        ![UDPChat main window](./screenshots/udpchat-mainwindow.png)
        
        Hosted at [udpchat://209.97.187.173](udpchat://209.97.187.173)
        
        ## How to set up and run the application.
        
        ### 1. Create a python virtual enviroment
        
        1. Run `python3 -m venv venv` to create the virtual enviroment.
        2. Run `source venv/bin/activate` to activate the virtual enviroment.
        3. Run `pip install -e .` to install dependencies to the virtual environment
        
        ### 2. Starting the server
        
        On localhost
        1. Run `python3 -m udp_chat.server` to start running the server. 
        
        On specified IP address
        1. Run `python3 -m udp_chat.server (IP address) (port number)` to start running the server
        
        
        ### 3. Starting a client GUI
        
        
        In a new terminal:
        
        Connect to a server on localhost
        1. Run `python3 -m udp_chat.gui_client` to start the client GUI 
        
        Connect to a server IP address 
        1. Run `python3 -m udp_chat.gui_client (IP address) (port number)` to start the client GUI
        
        
        ### 4. Starting a command line client
        
        Note: *Must already have created an account*
        
        In a new terminal:
        
        Connect to a server on localhost
        1. Run `python3 -m udp_chat.client` to start the client 
        
        Connect to a server IP address 
        1. Run `python3 -m udp_chat.client (IP address) (port number)` to start the client GUI 
        
        
        ### 5. Delete the enviroment
        
        
        1. Run `rm -rf venv` to delete the virtual enviroment
Platform: UNKNOWN
Description-Content-Type: text/markdown
