From 78a9079530508b237b1de488573ee009b0ab48d4 Mon Sep 17 00:00:00 2001 From: Rohit Kumar Date: Tue, 13 Oct 2020 19:59:12 +0530 Subject: [PATCH] Created README.md --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e45ddd --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# My Chat Backend + +This is a realtime chatting application, with great UI (similar to whatsapp). +This repository includes only back-end part of my-chat application. + +## Links +> [Backend deployed on heroku](https://my-chat-api.herokuapp.com) +> [Backend github](https://github.com/RohitKumar-200/my-chat-backend) +> [Deployed website](https://my-chat-289919.web.app) +> [Front-end github](https://github.com/RohitKumar-200/my-chat-frontend) + +## Tech Stack +* Node.js +* Express.js +* Pusher +* MongoDB / Mongoose + +## Setting up locally +1. Clone this repository +` git clone https://github.com/RohitKumar-200/my-chat-backend.git ` +2. cd to my-chat-frontend +4. create .env file and add following into it + > DB_CONNECTION=(Your mongoDB connection url) + > PUSHER_appId=(Pusher app Id) + > PUSHER_key=(Pusher Key) + > PUSHER_secret=(Pusher secret) +3. Run command +`npm install` +4. Start your server by running this command +`npm start` +5. Open your browser and open this link http://localhost:4000/ + +### If You liked my work, please ⭐ this repository \ No newline at end of file