Giter Club home page Giter Club logo

local-chat's Introduction

LocalChat

A chat application for chatting over a local network.

Image 1

Features

  • Hosting servers and joining chats
  • Saving chat logs to a file
  • Switch to show timestamps next to new chat messages
  • Dark/Light mode switch

How to use

Joining an existing server

Go to Chat -> Connect, select a server and type your username. Then click Connect.

Image 2

Note: The list of available servers refreshes every couple of seconds. If you don't see a server there, but you are sure there is one running make sure that all requirements are met.

Hosting a server

Go to Chat -> Host, select the server name and server message (a message that will be displayed to every user that connects to your chat), then click Host.

Image 3

Note: If you would like to attend the chat as well, it is perfectly safe to open another instance of this application on the same computer. With IDE/Terminal it is rather easy, but you would like to stick to graphical interface then just make a copy of the .jar file with a slightly different name, and you should be able to open it twice.

How to run/install

Standalone .jar file

Note: This only works for Windows and Linux machines. Mac users need to compile the application from source in order for it to work.

Download the JAR file from Releases page and double click on it to run the application.

Compile from source

You will need JDK and Maven for these steps!

Clone the repository and open the location of your local copy in your terminal, then run the following commands:

mvn clean package -DskipTests

java -jar target/local-chat-1.3-SNAPSHOT-jar-with-dependencies.jar

Requirements

  • JRE 17
  • Network that exists in a private address space (https://www.rfc-editor.org/rfc/rfc1918):
    • 10.0.0.0 - 10.255.255.255
    • 172.16.0.0 - 172.31.255.255
    • 192.168.0.0 - 192.168.255.255
  • All attendants need to make sure that they have port 5005 open
  • Supported operating system

Application works without issues on Windows and Linux operating systems, however on MacOS it has problems specific to JavaFX like no application icon being displayed in Dock or necessity to compile the application from source as MacOS security will not trust JavaFX libraries that originate from .jar file downloaded online.

Attributions

Application icon was created by Freepik - Flaticon

local-chat's People

Contributors

n3lx avatar

Stargazers

Ivan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.