Merge pull request #7 from prernagp/master

Refactored boilerplate readme

Author: shubhamp-sf

README.md

@@ -2,32 +2,27 @@
 [![Version](https://img.shields.io/badge/@angular/core-v14-brightgreen)](https://www.npmjs.com/package/@angular/cli/v/14.0.0)
 
 
-
 <!-- DOCUMENTATION -->
 
 ## Description
 
-  The boilerplate using multiple projects in one Angular environment so that the boilerplate help users 
-  to improve code  reusability,maintainability and customization. boilerplate can also help in increase productivity, reduce risks, and improve the quality of  application.
-  The multiple applications or parts of applications that share common functionality, using multiple
-  projects can help you avoid duplicating code. You can create a shared library project and use it across all the projects. This approach can help you maintain consistency and reduce code duplication.
-
+  This boilerplate uses multiple projects in single Angular workspace, which helps the users to develop shareable libraries, and for enterprises to use a "monorepo" development style, with a single repository and global configuration for all Angular projects. This boilerplate can also help in increasing productivity, reduce risks, and improve the quality of application.Duplication and redundant code can be avoided by using boilerplate approach.
 
 ## Usage
 
-#### Step 1: Clone the boilerplate project repository to your local machine
+### Step 1: Clone the boilerplate project repository to your local machine
 
 ```sh
 git clone https://github.com/sourcefuse/angular-boilerplate
 ```
 
-#### Step 2: Install the project dependencies by running the following command 
+### Step 2: Install the project dependencies by running the following command 
 
 ```sh
 npm install 
 ```
 
-After this, it will take a few minutes to set everything up, once that is done, you will see a folder structure generated like below:
+After this, it will take a few minutes to set everything up, once that is done, you will see a folder structure generated like the following:-
 
 ```
 BOILER-PLATE
@@ -45,19 +40,20 @@ BOILER-PLATE
 ├── README.md
 └── tsconfig.json
 ```
-As can be seen above, scaffold has initialized and set up a lot, such as:
+Some predefined settings are initialised:-
 
-1. GitHub PR template inside `.github`
-2. Conventional commits enablement using commitizen (`.cz-config.js`), commitlint (`commitlint-config.js`) 
+1. A GitHub PR template is created inside: `.github`
+2. Conventional commits are enabled using commitizen (`.cz-config.js`), commitlint (`commitlint-config.js`) 
    and husky for githooks.
 3. `.gitignore` for ignoring files from source code. Important for secure coding and keeping the repo clean 
     on SCM (git)
 4. `package.json` and `package-lock.json` for npm to work.
 5. The folder named `projects`: Projects will hold the multi application pattern and will always be 
-   completely independent 
+   completely independent.
 
-#### The Structure is main project folder 
+#### Projects
 
+##### Structure
 ```
 PROJECTS
 ├── arc
@@ -70,38 +66,45 @@ PROJECTS
 │            └── theme
 ├── (...other files)
 ```
-
-## Projects
-
-### Purpose of the Projects folder boilerplate have 
-  - Boilerplate use Multi project to avoid duplicate code and easy maintainance this can be used where 
-    we have to maintain multiple projects that have something in common like a user portal and admin portal
-    Here Boilerplate use "Projects" folder typically serves as a centralized location to organize and store project-related files and resources. 
-  - Boilerplate allows users to Generate new applications at same workspace with following command:
-
+##### Purpose 
+  - As stated above, the boilerplate uses Multi-projects pattern to avoid duplication and is easy to maintain.
+    Here Boilerplate use "Projects" folder, which serves as a centralized location to organize and store project-related files and resources. For example:- An application can have multiple user portal :- admin-portal and super-admin-portal. In that case, the structure of the "Projects" folder can look like the following:-
+    ```
+    PROJECTS
+    ├── admin-portal
+    ├── super-admin-portal
+    ├── shared-lib
+    │   └── src
+    │          └──lib
+    │            ├── assets
+    │            ├── components
+    │            ├── core
+    │            └── theme
+    ├── (...other files)
+    ```
+
+  - Boilerplate allows users to Generate new applications at same workspace by using the following command:
  ```sh
    ng generate application <application-name>
   ```
 
-1. Arc:
-- This boilerplate arc project is a project set up that can be easily altered to create new projects. 
-  The user is able to use in the original project, its foundation, and its structure to set up a new one without changing the original.
+  1. Arc:
+  - This refers to the different applications inside single workspace sharing code.
 
-2. Arc-Lib
-- A arc-lib shared library can include components, services, pipes, directives, and other modules that can be used  by other projects in the workspace. By using a shared library, we avoid duplicating code and functionality across multiple projects, which can save time and effort.
+  2. Arc-Lib
+  - This refers to the shared library which can include components, services, pipes, directives, and other modules that are shared among the applications in the workspace. By using a shared library, we avoid duplicating and using redundant code across, which can save time and effort.
 
 For further reference you can refer [Here](projects/arc-lib/README.md)
 
+### Step 3: Setup the application to run
 
-#### Step 3: Setup of Starting the Server
-
-- By Default boilerplate giving `defaultProject` as `arc` in the `angular.json` you can do further changes as per your Project requirment so that if you directly do `ng serve` your project run by default.
+- By default, boilerplate refers to `arc` as a `defaultProject` in the `angular.json`. One can modify it according to the project requirements.
 
 ```typescript
 "defaultProject": "arc",
 ```
 
-#### Step 4: Running Server
+### Step 4: Running Server
 
 ```sh
 ng serve
@@ -111,11 +114,12 @@ You'll see a message saying Server is running at `http://localhost:4200/` Naviga
 
 ##  Build the Application
 
- To build the project. The build artifacts will be stored in the `dist/` directory.
-
+ To build the project, run the following command:-
+ 
 ```sh
 ng build
 ```
+ The build artifacts will be stored in the `dist/` directory.
 
 ## Running unit tests
 
@@ -128,3 +132,6 @@ Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To u
 ## Further help
 
 To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+
+## References
+1. https://angular.io/guide/file-structure