Skip to content

Commit 013d47e

Browse files
committedMay 31, 2023
Improved readme and added .env.example and hide main env
1 parent 49409cf commit 013d47e

File tree

7 files changed

+59
-10
lines changed

7 files changed

+59
-10
lines changed
 

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
.env

‎README.md

+54-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,54 @@
1-
# Steps to Start the App
2-
3-
## Install the Public Dependencies
4-
## Install the Server Dependencies
5-
## In the Server Directory there's a .env file. Change the value of mongodb inside the file. Set the value as your mongodb connection url.
6-
## Now start the server by yarn start
7-
## Now start the react by yarn start
8-
## And the chat application would be running successfully by now.
1+
# Snappy - Chat Application
2+
Snappy is chat application build with the power of MERN Stack. You can find the tutorial [here](https://www.youtube.com/watch?v=otaQKODEUFs)
3+
4+
5+
![login page](https://github.com/rajkaranm/chat-app-react-nodejs/blob/improved-readme/images/snappy_login.png?raw=true)
6+
7+
![home page](https://github.com/rajkaranm/chat-app-react-nodejs/blob/improved-readme/images/snappy.png?raw=true)
8+
9+
## Installation Guide
10+
11+
### Requirements
12+
- [Nodejs](https://nodejs.org/en/download)
13+
- [Mongodb](https://www.mongodb.com/docs/manual/administration/install-community/)
14+
15+
Both should be installed and make sure mongodb is running.
16+
17+
```shell
18+
git clone https://github.com/koolkishan/chat-app-react-nodejs
19+
cd chat-app-react-nodejs
20+
```
21+
Now rename env files from .env.example to .env
22+
```shell
23+
cd public
24+
mv .env.example .env
25+
cd ..
26+
cd server
27+
mv .env.example .env
28+
cd ..
29+
```
30+
31+
Now install the dependencies
32+
```shell
33+
cd server
34+
yarn
35+
cd ..
36+
cd public
37+
yarn
38+
```
39+
We are almost done, Now just start the development server.
40+
41+
For Frontend.
42+
```shell
43+
cd public
44+
yarn start
45+
```
46+
For Backend.
47+
48+
Open another terminal in folder, Also make sure mongodb is running in background.
49+
```shell
50+
cd server
51+
yarn start
52+
```
53+
54+
Done! Now open localhost:3000 in your browser.

‎images/snappy.png

55.9 KB
Loading

‎images/snappy_login.png

33.8 KB
Loading

‎public/.env

-2
This file was deleted.

‎public/.env.example

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
REACT_APP_LOCALHOST_KEY="chat-app-current-user"

‎server/.env.example

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
PORT=5000
2+
MONGO_URL="mongodb://localhost:27017/chat"

0 commit comments

Comments
 (0)
Please sign in to comment.