Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 2.86 KB

README.md

File metadata and controls

97 lines (66 loc) · 2.86 KB

Redis Real-Time Chat Application

A real-time chat application built using Node.js, Socket.io, and Redis. This application allows users to join chat rooms, exchange messages, and see online users in real time.

Table of Contents

Features

  • Real-Time Messaging: Users can send and receive messages instantly using Socket.io.
  • Chat Rooms: Join different chat rooms and communicate with users.
  • User Presence: Track online users using Redis for session management.
  • Message History: Temporary storage of messages using Redis Streams.
  • Responsive Design: User-friendly interface that works on different devices.

Tech Stack

  • Backend: Node.js, Express, Socket.io
  • Redis: Used for session management, message broadcasting, logging history, and tracking user presence.
  • Frontend: HTML, CSS, JavaScript (with Socket.io for real-time communication)

Installation

Prerequisites

  • Node.js (>=14.x)
  • Redis (installed and running)

Steps

  1. Clone the repository:

    git clone https://github.com/Vrana710/ChatApp-Redis.git
cd ChatApp-Redis

  2. Install dependencies:

    npm install

  3. Start the Redis server: Make sure your Redis server is running. You can start it with the command:

    redis-server

  4. Run the application:

    node app.js

  5. Open your browser: Navigate to http://localhost:3000 to access the chat application.

Usage

  • Upon launching the application, users will be prompted to enter their name.
  • Once connected, users can send messages by typing in the input field and pressing Enter.
  • Messages will appear in the chat box with the sender's name.
  • You can open multiple browser tabs to simulate different users chatting.

Demo

Watch the demo video of the ChatApp-Redis

Demo.mp4

Alternatively, you can view the video directly in the browser here.

Note: If you are not able to see the video, you may need to download it to view it properly.

Contributing

Contributions are welcome! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-YourFeature).
  3. Make your changes and commit them (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature-YourFeature).
  5. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions or suggestions, feel free to contact me at [email protected].