LANChat is a simple chat application that runs over LAN. Currently, LANChat has a CLI that will be developed into a full GUI.
- Simple and lightweight
- Real-time messaging
- Easy setup and usage
- Python 3.9 or higher
- Required Python libraries (specified in
requirements.txt
)
-
Clone the repository:
git clone https://github.com/Iain-Crowe/LANChat.git cd LANChat
-
Create a virtual environment (highly recommended):
python -m venv venv
-
Locate the activate script in the environment and set environment variables:
For Linux (in
venv/bin/activate
)export SERVER_IP="0.0.0.0" # Your IP for the server to run on export SERVER_PORT=8080 # A port for the server to run on
For Windows (in
venv\Scripts\activate.bat
)set SERVER_IP="0.0.0.0" & REM Your IP for the server to run on set SERVER_PORT=8080 & REM A port for the server to run on
-
Activate the virtual environment:
For Linux (in
venv/bin/activate
)source venv/bin/activate
For Windows (in
venv\Scripts\activate.bat
)venv\Scripts\activate.bat
-
Install the dependencies:
pip install -r requirements.txt
-
Run the server script:
python server.py # src/server.py if in root dir
-
The server will start listening for incoming connections on the port specified.
-
Run the client script:
python client.py # src/client.py if in root dir
-
The client will start up and connect with the server.
The application uses a logging system to record events and errors. Logs are displayed on the command line. I will likely alter it to save a log file later.
Contributions are welcome! If you'd like to help out feel free to fork the repo and submit a pull request with any changes.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or feedback, please contact me at [iainccrowe@gmail.com].