ms-chat-app

A chapApp where you can express what you want
Explore the docs »

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running the code
3. Preview
4. Contributing
5. Contact

About The Project

ms-chat-app is the macro version of ms-teams where you can form groups and can message & share images with different people. You can also customize the UI by yourself. Built for both desktop and mobile. It uses react-chatengine APIs.

Built With

• ReactJS
• ReactChatEngine
• TailwindCSS

Preview

Visit the website here

Desktop View

Mobile view

Getting Started

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

Prerequisites

Package.json file mentioned the requirements you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• Any code editor of your choice (VScode preferable )

Installation

1. Clone the repo

   git clone https://github.com/mohitm15/ms-chat-app

2. Install NPM packages and requirements

   npm install or npm i

Running the code

1. To run the frontend server , go to project folder first

       cd ms-chat-app

   and then

       npm start

   The frontend server will run on localhost:/3000

2. To setup the backend server,

      Go to https://chatengine.io/

   and then

       register yourself

   The username & password you will chose by yourself. However, you will get a projectID.

3. Create a .env.local file in the root directory and paste the content as below

   REACT_APP_PROJECT_ID="<your project Id>"
   REACT_APP_USERNAME="<username>"
   REACT_APP_USER_SECRET="<password>"
   

   Now your environment variables also setup. You're ready to go.

Contributing

Contributions are what makes 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

Contact

Your Name -Mohit Maroliya

Project Link: https://github.com/mohitm15/ms-chat-app