ChatApp

TO-DO

• Add Emoji
• Improve Login / Register UI
• Send Images

Chat App

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Installation
3. Contributing
4. Contact

About The Project

Features

-It has basic functionality like Register/login, forgot password, update profile.
-Search other users, Send friend request to them.
-Send images and other media files.
-Typing Indicator, Server side message encryption

Built With

• NodeJS
• ExpressJS
• MongoDB
• ReactJS
• Socket.io
• AWS S3

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Fork, then download or clone the repo.

git clone https://github.com/harshil-270/ChatApp.git

For the back-end, go to home folder and install the dependencies once via the terminal.

npm install

If you want to configure the front-end, go to frontend folder via the terminal.

cd frontend

Install the dependencies required by React once.

npm install

Now create .env file and fill all the details.

MONGO_URI = 
JWT_SECRET = 
MESSAGE_KEY = PUT_MESSGAE_ENCRYPTION_KEY_HERE
GMAIL_USER = 
GMAIL_PASS = 
AWS_ACCESS_KEY_ID = 
AWS_SECRET_ACCESS_KEY = 
AWS_REGION = 
AWS_BUCKET_NAME = 

Now you are ready to run the server and frontend.

Contributing

Contributions are what make the open source community such an amazing place to be 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

Harshil Tagadiya - @Harshil Tagadiya - harshiltagadiya@gmail.com

Project Link: https://github.com/harshil-270/ChatApp