From 9bb077083e02b76a8e7578a7612ee8bb8d46ba93 Mon Sep 17 00:00:00 2001 From: minahil12345 <95999522+minahil12345@users.noreply.github.com> Date: Mon, 2 Dec 2024 17:56:45 +0500 Subject: [PATCH 1/3] Fixed typo in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 150b8d32..8147ae7c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Realtime Chat Application - +This File is actually made by Adrian which is forked by Minahil12345 in order to learn and practice Git CLI concepts ### [Live Site](https://realtime-chat-application.netlify.com) ### [🌟 Become a top 1% Next.js developer in only one course](https://jsmastery.pro/next15) From 5db98d64086df83637e6b2b317e39f82f25eaa08 Mon Sep 17 00:00:00 2001 From: minahil12345 <95999522+minahil12345@users.noreply.github.com> Date: Mon, 2 Dec 2024 18:20:49 +0500 Subject: [PATCH 2/3] adding skills in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8147ae7c..efb36ffb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Realtime Chat Application -This File is actually made by Adrian which is forked by Minahil12345 in order to learn and practice Git CLI concepts +This File is actually made by Adrian which is forked by Minahil12345 in order to learn and practice Git CLI concepts especially Forking, Commiting and Merging. ### [Live Site](https://realtime-chat-application.netlify.com) ### [🌟 Become a top 1% Next.js developer in only one course](https://jsmastery.pro/next15) From 38e43c47e8ccde559e926eea1f1a24d54ff0de0a Mon Sep 17 00:00:00 2001 From: minahil12345 Date: Mon, 2 Dec 2024 18:28:04 +0500 Subject: [PATCH 3/3] Added installation process in File end --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index efb36ffb..7c0d6a20 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,33 @@ By the end of this video, you will have a strong understanding of how to send an Setup: - run ```npm i && npm start``` for both client and server side to start the development server +Getting Started +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. + +Installation +BEFORE YOU INSTALL: please read the prerequisites + +Start with cloning this repo on your local machine: + +$ git clone https://github.com/ORG/PROJECT.git +$ cd PROJECT +To install and set up the library, run: + +$ npm install -S myLib +Or if you prefer using Yarn: + +$ yarn add --dev myLib +Usage +Serving the app +$ npm start +Running the tests +$ npm test +Building a distribution version +$ npm run build +This task will create a distribution version of the project inside your local dist/ folder + +Serving the distribution version +$ npm run serve:dist +This will use lite-server for servign your already generated distribution version of the project. + +Note this requires Building a distribution version first. \ No newline at end of file