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

https://github.com/jeanbuhendwa/chat-app

A simple, real-time chat application built with React, offering seamless communication with a modern, responsive UI. 🤖💻
https://github.com/jeanbuhendwa/chat-app

axios-react chatengineapi reactjs

Last synced: 9 months ago
JSON representation

A simple, real-time chat application built with React, offering seamless communication with a modern, responsive UI. 🤖💻

Awesome Lists containing this project

README

          

# 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

```bash
username: test
password: test123
```

## Table of Contents

- [Features](#features)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## 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](https://wtchat.netlify.app/).

## Installation

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

### Prerequisites

- [Node.js](https://nodejs.org/en/download/)
- npm (comes with Node.js) or [Yarn](https://classic.yarnpkg.com/en/docs/install/)

### Clone the Repository

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

### Install Dependencies

Using npm:

```bash
npm install
```

Or using Yarn:

```bash
yarn install
```

## Usage

### Running the App

To start the development server, run:

Using npm:

```bash
npm start
```

Or using Yarn:

```bash
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:

```bash
npm run build
```

Or using Yarn:

```bash
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.