From 0e8a8aa869f4c952186cdb6685fb73a18fd7772c Mon Sep 17 00:00:00 2001
From: Ashish Astang <97803019+ashish-astang@users.noreply.github.com>
Date: Thu, 15 Aug 2024 13:56:15 +0530
Subject: [PATCH] added readme

---
 README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b213549
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+
+# Talk-A-Tive
+
+Talk-a-tive is a Full Stack Chatting App.
+Uses Socket.io for real time communication and stores user details in encrypted format in Mongo DB Database.
+## Tech Stack
+
+**Client:** React JS
+
+**Server:** Node JS, Express JS
+
+**Database:** Mongo DB
+  
+## Demo
+
+[https://talk-a-tive.herokuapp.com/](https://talk-a-tive-7fgq.onrender.com)
+
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/group%20%2B%20notif.PNG)
+## Run Locally
+
+Clone the project
+
+```bash
+  git clone https://github.com/piyush-eon/mern-chat-app
+```
+
+Go to the project directory
+
+```bash
+  cd mern-chat-app
+```
+
+Install dependencies
+
+```bash
+  npm install
+```
+
+```bash
+  cd frontend/
+  npm install
+```
+
+Start the server
+
+```bash
+  npm run start
+```
+Start the Client
+
+```bash
+  //open now terminal
+  cd frontend
+  npm start
+```
+
+  
+# Features
+
+### Authenticaton
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/login.PNG)
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/signup.PNG)
+### Real Time Chatting with Typing indicators
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/real-time.PNG)
+### One to One chat
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/mainscreen.PNG)
+### Search Users
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/search.PNG)
+### Create Group Chats
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/new%20grp.PNG)
+### Notifications 
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/group%20%2B%20notif.PNG)
+### Add or Remove users from group
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/add%20rem.PNG)
+### View Other user Profile
+![](https://github.com/piyush-eon/mern-chat-app/blob/master/screenshots/profile.PNG)
+## Made By
+
+- [@Piyush-eon](https://github.com/piyush-eon)
+
+