Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.56 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.56 KB
Raw

JoyfulChat Desktop Client based on JavaFX (v.0.0.2)

Running

Get started

To get started with the project, you will need to have the following installed:

  • Java 8+

Once you have the necessary software installed, you can clone the project from GitHub:

git clone https://github.com/alexdoublesmile/joyful-chat-client.git

To run the project, open the project in your IDE and run the Main class, or you can use terminal.

Environment variables

While running, you can set some environment variables for additional chat server config:

Env name Description Default values
SERVER_HOST server host value localhost
SERVER_PORT server port value 8080
CLIENT_NAME client window name JoyfulChat
CLIENT_WIDTH window width (px) 500
CLIENT_HEIGHT window height (px) 500

Usage

Once the application is running, you connect automatically to the server by host and port.

Troubleshooting

If you encounter any problems running the project, please check the following:

  • Make sure you have the Java 8+ installed.
  • Make sure you are running the project from the root directory of the project.
  • Make sure you connected to the server by properly host and port.
  • If you are still having problems, please open an issue on GitHub.

Contributing

If you would like to contribute to the project, please fork the project on GitHub and submit a pull request.

License

JoyfulChat is licensed under the Apache 2.0 License.

Release Notes:

  • v0.0.1 - Initial internal release. This release only supports basic functionality.