Chat-App Documentation

Overview

Welcome to the documentation for the Chat-App project. This document provides an overview of the project structure, technologies used, and instructions for setup and usage.

Technologies Used

• Backend: Node.js, Express.js, MongoDB
• Frontend: React.js, TypeScript
• Styling: Tailwind CSS, DaisyUI
• Real-time Communication: Socket.io
• State Management: Zustand

Backend

Technologies

• Node.js: JavaScript runtime environment.
• Express.js: Web application framework.
• MongoDB: NoSQL database.

Setup

1. Navigate to the backend directory:

   cd backend

2. Install dependencies:

   yarn

3. Start the backend server:

   yarn dev

Frontend

Technologies

• React.js: JavaScript library for building user interfaces.
• TypeScript: Superset of JavaScript.
• Tailwind CSS: Utility-first CSS framework.
• DaisyUI: Tailwind CSS component library.
• Socket.io: Real-time communication library.
• Zustand: State management library.

Setup

1. Navigate to the frontend directory:

   cd frontend

2. Install dependencies:

   yarn

3. Start the frontend development server:

   yarn dev

Features

• Real-time chat using Socket.io.
• User authentication and authorization.
• State management with Zustand.
• Responsive design with Tailwind CSS and DaisyUI.

Usage

1. Register or login to the application.
2. Start chatting with other users in real-time.
3. Use the chat features provided by the application.