From 6d367c74fa579865086a490fa80de924cb7065f8 Mon Sep 17 00:00:00 2001 From: Zoha Waheed <128237901+Zoha-Waheed@users.noreply.github.com> Date: Sun, 26 May 2024 16:41:34 +0000 Subject: [PATCH 1/3] Markdown Syntax edited --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b8eebdf..fc4a2a5 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation HomePage

- Services

@@ -79,7 +79,8 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation Messages -

5. Groups +

+5. Groups - Group Creation: Effortlessly create group chats with the people you need. @@ -147,8 +148,8 @@ The illustration above showcases a conversation between two separate tabs opened 2. Install Packages: - - Install the required packages by navigating to the backend directory: cd backend and then run npm install. - - Similarly, move to the frontend directory: cd frontend and execute npm install. + - Install the required packages by navigating to the backend directory: `cd backend` and then run `npm install`. + - Similarly, move to the frontend directory: `cd frontend` and execute `npm install`. 3. To set up the frontend @@ -176,11 +177,11 @@ The illustration above showcases a conversation between two separate tabs opened 5. Start Backend Server: - - Start the backend server using the command: cd backend and then npm start. + - Start the backend server using the command: `cd backend` and then `npm start`. 6. Start Frontend: - - Finally, initiate the frontend with the command: cd frontend and then npm start. + - Finally, initiate the frontend with the command: `cd frontend` and then `npm start`. 7. Open `http://localhost:3000` with your browser to see the app From 0f62315faf28dc9ad4980c727e7ea00abf0439a0 Mon Sep 17 00:00:00 2001 From: Zoha Waheed <128237901+Zoha-Waheed@users.noreply.github.com> Date: Sun, 26 May 2024 17:31:59 +0000 Subject: [PATCH 2/3] Formatted all inconsistencies --- README.md | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index fc4a2a5..cfc1195 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + # ChatBox-Web App🌟 @@ -17,7 +17,7 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation - [Features and Interfaces](#features) - [Home](#home) - - [Login and Authentication](#auth) + - [Login/Signup](#auth) - [Chats](#chats) - [Messages](#messages) - [Groups](#group) @@ -34,22 +34,21 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation - [Links](#links) - [Contact](#contact) - + ## Features and Interfaces -1. Home Page +1. Home Page - [Landing Page](https://chat-box-samarthkadam.vercel.app/) which lists all the features of the app

- HomePage + Home Page

Services -

-2. Login/Signup Page (Authentication) +2. Login/Signup - Fast and secure authentication - JWT tokens used to persist the authentication state @@ -59,7 +58,7 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation

-3. Chats +3. Chats - Conversation History: View a comprehensive list of all your past chats, including details about whom you've chatted with and the timestamps of each conversation. @@ -69,7 +68,7 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation

-4. Messages +4. Messages - Effortless Chatting: Easily communicate with others through Socket.IO's seamless functionality. @@ -80,7 +79,7 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation Messages

-5. Groups +5. Groups - Group Creation: Effortlessly create group chats with the people you need. @@ -88,7 +87,7 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation

Group -

6. Search +

6. Search - Robust Search Functionality: Powerful search feature to easily find people within the application. @@ -96,7 +95,7 @@ Welcome to Chatbox, your go-to platform for effortless and engaging conversation Group -

7. Settings +

7. Settings - Credential Updates: Easily modify your credentials such as email, name like information. @@ -113,7 +112,7 @@ The illustration above showcases a conversation between two separate tabs opened ## Tech stack - + #### Frontend @@ -123,7 +122,7 @@ The illustration above showcases a conversation between two separate tabs opened - MaterialUI - TailWindCSS - + #### Backend @@ -131,14 +130,14 @@ The illustration above showcases a conversation between two separate tabs opened - Express - MongoDB - + #### Other Tools - Socket IO - NPM Packages - + ## Instructions @@ -195,13 +194,13 @@ REACT_APP_SOCKET_URL=https://chatbox-api-bj21.onrender.com - + ## Useful Links - [Project Demo](https://chat-box-samarthkadam.vercel.app/) - + ## Need help? From 157c832ea089ae6f4d986660c6b9502e9404ecf5 Mon Sep 17 00:00:00 2001 From: Zoha Waheed <128237901+Zoha-Waheed@users.noreply.github.com> Date: Sun, 26 May 2024 17:54:06 +0000 Subject: [PATCH 3/3] Reduncy in "Quick setup" edited --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cfc1195..52fbefa 100644 --- a/README.md +++ b/README.md @@ -137,27 +137,39 @@ The illustration above showcases a conversation between two separate tabs opened - Socket IO - NPM Packages - + ## Instructions 1. Clone the project: - - Firstly, clone the project using the command: https://github.com/SamarthKadam/ChatBox + - Firstly, clone the project using the command: + ```bash + git clone https://github.com/SamarthKadam/ChatBox.git + ``` 2. Install Packages: - Install the required packages by navigating to the backend directory: `cd backend` and then run `npm install`. + ``` + cd backend + npm start + ``` - Similarly, move to the frontend directory: `cd frontend` and execute `npm install`. + ``` + cd frontend + npm start + ``` 3. To set up the frontend - Create a `.env` file in the frontend directory. - Add the following values to the `.env` file: + ``` REACT_APP_API_URL=http://127.0.0.1:4000 REACT_APP_SOCKET_URL=http://127.0.0.1:4000 - + ``` 4. For configuring the backend: - Establish your applications connection with MongoDB using following environment variables as key with your own values. @@ -177,10 +189,18 @@ The illustration above showcases a conversation between two separate tabs opened 5. Start Backend Server: - Start the backend server using the command: `cd backend` and then `npm start`. + ``` + cd backend + npm start + ``` 6. Start Frontend: - Finally, initiate the frontend with the command: `cd frontend` and then `npm start`. + ``` + cd frontend + npm start + ``` 7. Open `http://localhost:3000` with your browser to see the app