From 805e170e461ce85292728d10f559d0b7097134e8 Mon Sep 17 00:00:00 2001 From: rishav rajput Date: Wed, 14 Apr 2021 00:17:47 +0530 Subject: [PATCH] Update readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index f4277a5..0e99097 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ # CRED-T6 + Team ID: CRED-T6 | Team Members: Rishav Raj & Shivam Kirti + + +## Installation and Configuration + +- Clone the repository + +- Move to the main directory `cd CRED-T6` + +- Run the command `npm install` + +- Move to `client` directory `cd client` + - Run the commant `npm install` + - Return to main directory ` cd ..` + +- Run the command `npm run dev` + +- Default port is 3000. So, locally it will be hosted on `localhost:3000` + +- Deployment is done on heroku [link to project](https://blooming-basin-62987.herokuapp.com/) + + + +## Tech Stack Used + +- React JS +- NodeJS +- Express +- MongoDB +