Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.54 KB

README.md

File metadata and controls

43 lines (31 loc) · 2.54 KB

Kind Words Messaging Application

This is a web chat application project inspired by the popular game Kind Words. Users can communicate with each other in real-time. It is built using the Spring Boot framework for the backend and React for the frontend. The project utilizes Maven as the build tool for the backend.

This project was inspired by a previous hackathon project. The main difference is that this app is using the Spring Boot framework written in Java.

Users are strongly encouraged to use positive, inclusive language in the chat. Make someone else's day brighter by offering words of comfort, sympathy or gentle advice.

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.
  • File 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.
  • 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/mguan2020/Kind-Words-Messaging-App.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. Chat Page

  • Chatroom

  • Private Text