Skip to content

Latest commit

 

History

History
114 lines (74 loc) · 2.06 KB

README.md

File metadata and controls

114 lines (74 loc) · 2.06 KB
Raw

WTchat App

Welcome to WT-Chat! This project is built using React.js and Chat Engine to provide a real-time messaging platform. Below you'll find detailed information about the project, how to set it up, and how to contribute.

Demo Account

username: test
password: test123

Table of Contents

Features

  • Real-time messaging
  • User authentication
  • Chat rooms
  • Media sharing (images)
  • Typing indicators
  • Online status indicators

Demo

A live demo of the app can be found here.

Installation

To get a local copy up and running, follow these simple steps:

Prerequisites

Clone the Repository

git clone https://github.com/jeanbuhendwa/chat-app
cd chat-app

Install Dependencies

Using npm:

npm install

Or using Yarn:

yarn install

Usage

Running the App

To start the development server, run:

Using npm:

npm start

Or using Yarn:

yarn start

This will launch the app in your default web browser. You should see your chat app running at http://localhost:3000.

Building the App

To create a production build, run:

Using npm:

npm run build

Or using Yarn:

yarn build

This will create an optimized build of the app in the build directory.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.