Skip to content

Commit

Permalink
🧨initial setup and installation instruction added
Browse files Browse the repository at this point in the history
resolves #2
  • Loading branch information
joel-jaimon authored Nov 19, 2021
1 parent c2b0839 commit 68758df
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,62 @@ For more details about the functionalities of the clone, please visit the follow
https://joeljaimon.com/whatsapp-clone/about


#### Initial Setup:

Create a .env file inside of client and server folders respectively:

**- whatsapp-client/.env**
```
REACT_APP_GAUTH_CLIENT_ID=<Your_gauth_client_id>
REACT_APP_SERVER_URL=http://localhost:8181
REACT_APP_PEER_SERVER_URL=http://localhost:9000
```

**- whatsapp-server/.env**
```
MONGO_PASSWORD=<your_mondodb_password>
MONGO_USERNAME=<your_mongo_username>
GAUTH_CLIENT_ID=1<Your_gauth_client_id>
GAUTH_CLIENT_SECRET=<Your_gauth_client_secret>
JWT_REFRESH_SECRET=ERDTFGYUHIJKOftgybhjnkmTYFYGBHUNJ%^TUGHYNJKBVGFYGUHKJHVHFCV~BJHk
JWT_ACCESS_SECRET=TYFGHBJNKU*&YIUGJBHNKMLIYUHJKML<*&^YGHBNM<LO*&^%REW@ERFVBHJUYGVBN
AWS_S3_BUCKET_NAME=<s3_bucket_name>
AWS_S3_REGION_NAME=<s3_region_name>
AWS_ACCESS_KEY_ID=<access_key_id>
AWS_SECRET_ACCESS_KEY=<aws_secret_access_key>
```

Make sure to create a IAM user with the required policies. For this project I've used my custom policy:
![policy example](https://user-images.githubusercontent.com/64752455/142682383-2371f184-0679-4574-9dce-89907541e37f.PNG)

Also, you should have node installed, also a Redis server running on its default port (6379).
Once the above part is done.

### Installation:

- In whatsapp-server run:<br>
`npm run dev`

- In whatsapp-client run:<br>
`npm start`

### Redux Store
https://user-images.githubusercontent.com/64752455/142684906-f56231a1-8c20-4304-afee-f305b43a2077.mp4

### Mongo DB:
![mongo-db](https://user-images.githubusercontent.com/64752455/142684716-194b2ba5-1a3f-4ee7-a987-f594e00b2ea1.PNG)

### AWS S3:
![aws-s3](https://user-images.githubusercontent.com/64752455/142684407-1d79162e-b73b-41ab-a36d-ac408200f712.PNG)

<br>
<br>

## Whatsapp clone using firebase (Old Version):

A modified version of WhatsApp Web where you can create global rooms and chat in realtime. It uses firebase for google authentication and uses its NoSQL and SQL hybrid as database. React Context API is used for managing global state.
Expand Down

0 comments on commit 68758df

Please # to comment.