Menu

Tree [368eb9] main /
 History

HTTPS access


File Date Author Commit
 .github 2024-03-15 David David [bd3fff] Create FUNDING.yml
 static 2024-02-21 David David [587c7f] Add files via upload
 templates 2024-02-21 David David [587c7f] Add files via upload
 .gitignore 2024-02-21 David David [421a64] Initial commit
 LICENSE 2024-02-21 David David [421a64] Initial commit
 README.md 2024-04-06 David David [368eb9] Updated README.md
 app.py 2024-02-21 David David [587c7f] Add files via upload
 messages.json 2024-02-21 David David [587c7f] Add files via upload
 requirements.txt 2024-04-03 David David [9ba2f9] Created requirements.txt
 users.json 2024-02-21 David David [587c7f] Add files via upload

Read Me

# Internal LAN Chat System This proof of concept demonstrates an internal LAN chat system designed for efficient communication within a local network. Utilizing Flask and SocketIO, the system offers real-time messaging capabilities and a simple authentication mechanism.

Features

  • User Authentication: Login system based on a JSON file storing user credentials.
  • Real-Time Messaging: Utilizes Flask-SocketIO for instant message broadcasting across the network.
  • Chat History: Messages are stored and retrieved from a JSON file, ensuring that chat history is maintained.
## ☕ [Support my work on Ko-Fi](https://ko-fi.com/thatsinewave)

Installation

  1. Ensure Python 3.x is installed.
  2. Install required packages:
    pip install flask flask-socketio
  3. Clone the repository and navigate to the project directory.

Usage

  1. Start the application:
    python app.py
  2. Access the login page through a web browser within the LAN at http://localhost:5000.
  3. Log in using credentials stored in users.json.
  4. Begin chatting!

Configuration

  • Users: User credentials can be managed in the users.json file.
  • Messages: Chat history is automatically saved in messages.json.

Development

This project is a proof of concept. Further development can include features like enhanced security, user management interfaces, and scalability improvements.

License

This project is open-sourced under the MIT License.