Skip to content

xrimsonn/real-time-chat-spring

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RealTimeChat

This project is a real-time chat application using WebSocket, SocketJS, PicoCSS, Lombok, and Spring. It allows users to engage in instant messaging with each other.

Features

  • Real-time messaging: Users can send and receive messages instantly.
  • Simple UI: The user interface is built using PicoCSS for a lightweight and minimalist design.
  • Backend with Spring: The backend server is implemented with Spring, providing robustness and scalability.
  • Lombok for boilerplate reduction: Lombok is used to reduce boilerplate code, making the codebase cleaner and more concise.

Prerequisites

You will need to have installed:

  • Java 21
  • Maven

How to Run the Project

Set up:

  1. Clone the repository to your local machine using git clone https://github.com/xrimsonn/real-time-chat-spring.git.

  2. Navigate to the project directory.

  3. Run the command mvn install to download dependencies.

  4. Run the Spring Boot application using mvn spring-boot:run.

The backend server should now be running and you can go to the index on http://localhost:8080.

Use:

  1. Open the frontend application in your web browser.

  2. Enter your username and join the chat room.

  3. Start sending and receiving messages in real-time.

Enjoy chatting with other users in real-time!