Skip to content

Commit 30c2568

Browse files
committed
README file is updated
1 parent c06c65b commit 30c2568

File tree

1 file changed

+27
-24
lines changed

1 file changed

+27
-24
lines changed

README.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,19 @@
33
A Simple Chat Application using [React JS](https://reactjs.org/docs/getting-started.html), a JavaScript library to make awesome UI by Facebook, [Node JS](https://nodejs.org/en/docs), [Express JS](https://expressjs.com/en/api.html) and [MongoDB](https://docs.mongodb.com/).
44

55
This application uses [React JS](https://reactjs.org/docs/getting-started.html) component oriented UI creation paradigm. All components are written in [JSX](https://reactjs.org/docs/jsx-in-depth.html) and ES6 style and are
6-
combined to get a single build for production purpose using [Webpack 5](https://webpack.js.org/concepts/).
6+
combined to get a single build for production purpose using [Webpack 5](https://webpack.js.org/concepts/).
77

8-
ES6 `module` creation along with `import /export` is used. [Babel](https://babeljs.io/docs/en/babel-preset-react) is used to *transpile* all [JSX](https://reactjs.org/docs/jsx-in-depth.html) code to vanilla JavaScript code. To install all the dependecies `npm` is used.
9-
10-
Back end is implemented using [Node JS](https://nodejs.org/en/docs), [Express JS](https://expressjs.com/en/api.html) and [MongoDB](https://docs.mongodb.com/). [Atlas](https://www.mongodb.com/cloud/atlas), the *Cloud* version of [MongoDB](https://docs.mongodb.com/) is used. Real time communication is done using [Socket.io](https://www.npmjs.com/package/socket.io)
8+
ES6 `module` creation along with `import /export` is used. [Babel](https://babeljs.io/docs/en/babel-preset-react) is used to _transpile_ all [JSX](https://reactjs.org/docs/jsx-in-depth.html) code to vanilla JavaScript code. To install all the dependecies `npm` is used.
119

10+
Back end is implemented using [Node JS](https://nodejs.org/en/docs), [Express JS](https://expressjs.com/en/api.html) and [MongoDB](https://docs.mongodb.com/). [Atlas](https://www.mongodb.com/cloud/atlas), the _Cloud_ version of [MongoDB](https://docs.mongodb.com/) is used. Real time communication is done using [Socket.io](https://www.npmjs.com/package/socket.io)
1211

1312
For UI creation [HTML5](https://www.w3schools.com/html/html5_intro.asp) and [CSS3](https://www.w3schools.com/css/) are used. [Grid](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout), the new feature of [CSS3](https://www.w3schools.com/css/) is used for layout creation purpose.
1413

15-
This is a *responsive web application* for viewing in both Mobile and Desktop.
16-
14+
This is a _responsive web application_ for viewing in both Mobile and Desktop.
1715

1816
## Features
19-
- Code is rewritten with [React JS 17](https://reactjs.org/docs/getting-started.html) and [Node JS 15](https://nodejs.org/en/docs/)
17+
18+
- Code is rewritten with [React JS 17](https://reactjs.org/docs/getting-started.html) and [Node JS 17](https://nodejs.org/en/docs/)
2019
- Latest features of JavaScript i.e. ES6, ES7, ES8 is used
2120
- [React JS Hooks](https://reactjs.org/docs/hooks-intro.html) are used with Functional components
2221
- ES8 `async/await` is used
@@ -28,24 +27,24 @@ This is a *responsive web application* for viewing in both Mobile and Desktop.
2827
<li> It is a Full Stack Application </li>
2928
</ul>
3029

31-
- All the user details, rooms and conversations are stored in the [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). This is a *free/ shared* account on [Atlas](https://www.mongodb.com/cloud/atlas). **So Please use it wisely**
30+
- All the user details, rooms and conversations are stored in the [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). This is a _free/ shared_ account on [Atlas](https://www.mongodb.com/cloud/atlas). **So Please use it wisely**
3231

3332
<ul>
3433
<li>Login as well as Logout feature is added </li>
3534
<li>Error will be shown if the credentials are not correct</li>
3635
</ul>
3736

38-
- *for simplicity passwords are not encrypted*
37+
- _for simplicity passwords are not encrypted_
3938

4039
<ul>
4140
<li> Real time communication is supported using <a href="https://www.npmjs.com/package/socket.io">Socket.io</a>
4241
<li> Rooms with users are supported </li>
4342
<li> Conversation of a specific rooms will be shown on clicking the corresponding room</li>
4443
</ul>
4544

46-
- *for mobile screen user can go to the rooms page by clicking the `<-` icon at the end of the screen*
47-
- Multiline message can be send by hitting `Ctrl + ENTER`
48-
- To send a message hit `ENTER` key
45+
- _for mobile screen user can go to the rooms page by clicking the `<-` icon at the end of the screen_
46+
- Multiline message can be send by hitting `Ctrl + ENTER`
47+
- To send a message hit `ENTER` key
4948

5049
<ul>
5150
<li> Online / Offline status are shown by the <i>violet dot</i> </li>
@@ -57,22 +56,31 @@ This is a *responsive web application* for viewing in both Mobile and Desktop.
5756
## Installation
5857

5958
Clone the repository:
59+
6060
```
6161
git clone https://github.com/anijitsahu/react-app-simple-chat-app.git
6262
```
63+
6364
Navigate inside the directory:
65+
6466
```
6567
cd react-app-simple-chat-app
6668
```
69+
6770
Install all the necessary dependecies
71+
6872
```
6973
npm install
70-
```
74+
```
75+
7176
Now run the server:
77+
7278
```
7379
npm run server
7480
```
81+
7582
### Login to chat
83+
7684
---
7785

7886
1. Open `2` web browser and type`http://localhost:3000` in the address bar to load the application in each of them
@@ -81,18 +89,16 @@ npm run server
8189

8290
**Test users**
8391

92+
| Username | Password |
93+
| -------- | --------- |
94+
| anijit | anijit123 |
95+
| jeetm | jeetm76 |
8496

85-
Username | Password
86-
--- | ---
87-
anijit | anijit123
88-
jeetm | jeetm76
89-
90-
91-
*tested with <img src="screenshots/chrome.png" width="20px" title="Google Chrome">[Google Chrome 89](https://www.google.com/chrome/) and <img src="screenshots/firefox.png" width="25px" title="Firefox Developer edition">[Mozilla Firefox 86](https://www.mozilla.org/en-US/firefox/new/)*
97+
_tested with <img src="screenshots/chrome.png" width="20px" title="Google Chrome">[Google Chrome 89](https://www.google.com/chrome/) and <img src="screenshots/firefox.png" width="25px" title="Firefox Developer edition">[Mozilla Firefox 86](https://www.mozilla.org/en-US/firefox/new/)_
9298

9399
## Screenshots
94100

95-
Some screens of the application is given below for better understanding.
101+
Some screens of the application is given below for better understanding.
96102

97103
Desktop as well as Mobile version of the screenshots are given side by side.
98104

@@ -145,6 +151,3 @@ Desktop as well as Mobile version of the screenshots are given side by side.
145151
<img src="screenshots/desktop 11.png" width="590px" title="Logout functionality screen"/>
146152
<img src="screenshots/mobile 11.png" width="250px" title="Logout functionality screen"/>
147153
</p>
148-
149-
150-

0 commit comments

Comments
 (0)