An open API service indexing awesome lists of open source software.

https://github.com/debasishbihari/quick-chat-app

Quick Chat App is a real-time messaging application that allows users to communicate instantly with each other. Built with a modern tech stack, it ensures seamless and efficient communication.
https://github.com/debasishbihari/quick-chat-app

axios bcryptjs cloudinary css3 emoji-picker-react express-js html5 jsonwebtoken mongodb nodejs react-hot-toast react-redux react-router-dom reactjs redux redux-toolkit socket-io socketio-client

Last synced: 3 months ago
JSON representation

Quick Chat App is a real-time messaging application that allows users to communicate instantly with each other. Built with a modern tech stack, it ensures seamless and efficient communication.

Awesome Lists containing this project

README

          

## 📋 Table of Contents

1. 🤖 [Introduction](#introduction)
2. ⚙️ [Tech Stack](#tech-stack)
3. 🔋 [Features](#features)
4. 🤸 [Quick Start](#quick-start)

## 🤖 Introduction

Quick Chat App is a real-time messaging application that allows users to communicate instantly with each other. Built with a modern tech stack, it ensures seamless and efficient communication.

## ⚙️ Tech Stack

- React
- Redux Toolkit
- Tailwind CSS
- Node.js
- Express.js
- MongoDB
- Socket.io
- Cloudinary

## 🔋 Features

👉 User Authentication: Secure signup and login functionalities to ensure user data privacy and protection.

👉 Real-time Messaging: Instantaneous message delivery and reception, providing a seamless chat experience.

👉 Read Receipts: Visual indicators to show when messages have been read by the recipient.

👉 Online Status Indicator: Real-time display of users' online or offline status, enhancing engagement.

👉 Typing Indicator: Live notifications when a contact is typing, making conversations more interactive.

👉 Profile Management: Users can create and update personal profiles, including avatars.

👉 Image Sharing in Chat: Seamless sharing of images within the chat, enriching the communication experience.

👉 Emoji Support: A wide range of emojis to express emotions and reactions within conversations.

These features collectively provide a comprehensive and engaging real-time chat application experience.

## 🤸 Quick Start

Follow these steps to set up the project locally on your machine.

**Prerequisites**

Make sure you have the following installed on your machine:

- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)

**Cloning the Repository**

```bash
git clone https://github.com/debasishbihari/quick-chat-app.git
cd quick-chat-app
```
**Installation**

Install the project dependencies using npm:

```bash
cd client
npm install
cd server
npm install
```
**Set Up Environment Variables**

Create a new file named `config.env` in the root of server folder and add the following content:

```env
PORT_NUMBER =
CONN_STRING =
SECRET_KEY =
```
Replace the values with your actual credentials. You can obtain CONN_STRING by signing up &
creating a new database on the [MongoDB Cloud](https://www.mongodb.com/). Add a Port Number and secret key of your own.

**Running the Project**
-For server
```bash
npm run dev
```
-For client
```bash
npm start
```