README.md

Wire Protocol & RPCs

Emeka Ezike & Victor Goncalves

Engineering Notebook

Getting Started:

1. Clone the repository here
2. Note, there are two folders in the repo: ordinary deals with the wire protocol code and grpc deals with gRPC
3. Ensure that the most recent version of Python is downloaded here
4. Ensure that gRPC is downloaded for Python using the following commands
   • pip install grpcio
   • pip install grpcio-tools
5. We use Tkinter for the GUI, so download it with the following command:
   • pip install tk
6. Lastly, we use port 50051 as default in each server file

Part 1: Wire Protocol Steps:

1. cd ordinary
2. For the server run: python ./server.py
   • Should print the server IP and port no. Keep track of these
3. For each client run: python ./app.py
   • Connect to the IP and port as listed above
   • Register for an account or log in w/a username and password
   • Once logged in, select the user you are trying to send a message to via dropdown, type the message, then hit send
   • If desired, delete the account when finished.
   • Note: have at least two clients running in two separate terminals

Part 2: gRPC Similar steps as above:

1. cd grpc
2. For the server run: python ./server.py
   • Should print the server IP and port no. Keep track of these.
3. For each client run: python ./app.py
   • Connect to the IP and port as listed above
   • Register for an account or log in w/a username and password
   • Once logged in, select the user you are trying to send a message to via dropdown, type the message, then hit send
   • If the account has been created, but is not visible in the dropdown menu, click "reset options" to update the dropdown.
   • If desired, delete the account when finished.
   • Note: have at least two clients running in two separate terminals
4. For running unit tests, just run python ./unit_tests.py
   • Note: don't run this for the demo as we reset the database to account for testing.