Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.91 KB

README.md

File metadata and controls

51 lines (38 loc) · 2.91 KB

Springboot-chatapp

Chat Application Project

This is a chat application project that allows users to communicate with each other in real-time. It is built using the Spring Boot framework for the backend, SockJS for WebSocket communication, and React for the frontend. The project utilizes Maven as the build tool for the backend.

Features

  • User Authentication: Users are required to log in with a username before they can access the chat application.
  • Real-time Chat: Once logged in, users are directed to the chat page where they can send messages in the chatroom.
  • User Presence: Users are notified when new users join the chatroom, allowing them to be aware of other participants.
  • Private Messages: Users have the ability to send private messages to specific individuals.
  • Multimedia Transfer: The application supports the transfer of multimedia files, such as photos and videos.
  • Logout: Users can log out from the application, and their username will be removed from the user list displayed to other participants.

Tech Stack

The application incorporates the following technologies:

  • Spring Boot: A Java-based framework used for building the backend server and handling business logic.
  • SockJS: A WebSocket emulation library that enables real-time communication between the server and clients.
  • React: A JavaScript library used for building the user interface and handling frontend functionality.

Setup Instructions

To run the chat application locally, follow these steps:

  1. Clone the repository: git clone https://github.com/Kshitijk5/Springboot-chatapp.git
  2. Navigate to the project directory: cd chatroom-backend
  3. Set up the backend server:
    • Install the necessary dependencies: mvn clean install
    • Start the Spring Boot server: mvn spring-boot:run
  4. Set up the frontend:
    • Install the necessary dependencies: cd chatroom-ui && npm install
    • Start the React development server: npm run dev
  5. Open your web browser and visit http://localhost:5173 to access the chat application.

Screenshots

Here are some screenshots of the chat application:

  1. Login Page

  2. Chat Page

  • Chatroom

  • Private Text

Feel free to explore and enhance the application according to your requirements.

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please create a new issue in the repository. You can also submit pull requests to contribute directly to the project.

License

The chat application project is open-source and released under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.