PartyChat

Table of Contents

0. Table of Contents
1. Introduction
2. Building
3. Usage
4. License

Introduction

Party chat is an open-source chat application that allows individuals connected to the same network to chat without the need of internet or registration.

Building

1. Clone the github repository & navigate to the local repo

git clone https://github.com/ItsMonish/PartyChat
cd PartyChat

2. The project is built and managed using gradle (wrapper). Therefore, it can be easily built using

./gradlew build

Upon successful build, the application is present under app/buid/libs/app.jar

Usage

In order to run the application

On Windows

Simply double-click the .jar file (ensure that Java Runtime 11 or above is installed)

On Linux and other *NIXs

java -jar <PATH_TO_JAR_FILE>

License

Party chat is licensed under BSD 3 clause license. For a detaiiled license, see LICENSE