CLAVARDAGE

Clavardage: A decentralized chat
See Releases »

Read the PDF Report (French) · See Test Results · Show JIRA Project

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Execution
   • Tests
   • Generation
   • Documentation
   • JAR Archive
   • Executable (optional)
4. Tree Structure
5. Credits
6. Contact

---

About The Project

Built With

• Java OpenJDK
• SQLite

Getting Started

Prerequisites

• Install a Java OpenJDK version 17. For example you can use one of the Temurin build available here: https://adoptium.net/releases.html?variant=openjdk17

⚠️ In order to create an local executable (optional) : Other programs will have to be manually installed depending on the target OS (see Executable (optional)).

Installation

1. Clone the project

   git clone https://github.com/Clavardage/clavardage.git

2. Clavardage is now ready to run.

Usage

Execution

Use the following script in the project root to launch Clavardage :

gradlew run

Tests

You can run the unit tests powered by JUnit 5 with the following command:

gradlew test

Generation

To generate the Javadoc and the JAR archive, launch the following script :

gradlew build

Documentation

During the build Clavardage uses a Gradle script to generate the Javadoc which can be found in the following location: clavardage/build/docs. The script can be run separately from the build:

gradlew javadoc

JAR Archive

A Gradle script is also used during the build to generate the JAR archive which can be found at the following location: clavardage/build/libs. The script can be run separately from the build:

gradlew jar

This archive is independent and can be distributed on any system running a Java OpenJDK 17 using the following command:

java -jar clavardage-1.0.0.jar

Executable (optional)

Finally a last Gradle script can be used after the build to create an executable compatible with the local OS (with the help of the jpackage tool) which can be found at this location: clavardage/build/dist. The script to run is the following:

gradlew jpackage

⚠️ To carry out this step you must have the following programs depending on the OS used :

• Linux: deb, rpm:
  • For Red Hat Linux, the rpm-build package is required.
  • For Ubuntu Linux, the fakeroot package is required.
• macOS: pkg, app in a dmg
  • Xcode command line tools are required when the --mac-sign option is used to request that the package be signed, and when the --icon option is used to customize the DMG image.
• Windows: exe, msi
  • WiX 3.0 or later is required.

---

Tree Structure

TODO

Credits

Romain Monier [ GitHub ] – Co-developer
Célestine Paillé [ GitHub ] – Co-developer

Contact

Project Link : https://github.com/Clavardage/clavardage