Merge pull request #4 from sourcefuse/GH-3

feat:angular multi-app structure project

Author: yeshamavani

.gitignore

@@ -7,3 +7,4 @@ lerna-debug.log
 **/.DS_Store
 .nyc_output
 dist
+/.angular/cache

README.md

@@ -1,15 +1,130 @@
-# Sourceloop Angular Boiler Plate
+# ARC ANGULAR BOILERPLATE
+[![Version](https://img.shields.io/badge/@angular/core-v14-brightgreen)](https://www.npmjs.com/package/@angular/cli/v/14.0.0)
 
-### Feedback
 
-If you've noticed a bug or have a question or have a feature request, [search the issue tracker]([Issues · sourcefuse/angular-boilerplate · GitHub](https://github.com/sourcefuse/angular-boilerplate/issues)) to see if someone else in the community has already created a ticket. If not, go ahead and [make one](https://github.com/sourcefuse/angular-boilerplate/issues/new/choose)! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please [star](https://help.github.com/en/articles/about-stars) it. Appreciation really helps in keeping this project alive.
 
-### Code of Conduct
+<!-- DOCUMENTATION -->
 
-Code of conduct guidelines [here.](CODE_OF_CONDUCT.md)
+## Description
 
-### License
+  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.
 
-[MIT](LICENSE)
 
-<!-- docs-index-end -->
+## Usage
+
+#### 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 
+
+```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:
+
+```
+BOILER-PLATE
+├── .github
+├── .husky
+├── projects
+├── .czferc.js
+├── .npmrc
+├── .cz-config.js
+├── .gitignore
+├── commitlint.config.js
+├── CODE_OF_CONDUCT.md
+├── package-lock.json
+├── package.json
+├── README.md
+└── tsconfig.json
+```
+As can be seen above, scaffold has initialized and set up a lot, such as:
+
+1. GitHub PR template inside `.github`
+2. Conventional commits enablement 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 
+
+#### The Structure is main project folder 
+
+```
+PROJECTS
+├── arc
+├── arc-lib
+│   └── src
+│          └──lib
+│            ├── assets
+│            ├── components
+│            ├── core
+│            └── 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:
+
+ ```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.
+
+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.
+ 
+For further reference you can refer [Here](projects/arc-lib/README.md)
+
+
+#### 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.
+
+```typescript
+"defaultProject": "arc",
+```
+
+#### Step 4: Running Server
+
+```sh
+ng serve
+```
+
+You'll see a message saying Server is running at `http://localhost:4200/` Navigate to this URL. The application will automatically reload if you change any of the source files.
+
+##  Build the Application
+
+ To build the project. The build artifacts will be stored in the `dist/` directory.
+
+```sh
+ng build
+```
+
+## Running unit tests
+
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Running end-to-end tests
+
+Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
+
+## 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.

angular.json

@@ -0,0 +1,171 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "arc": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "root": "projects/arc",
+      "sourceRoot": "projects/arc/src",
+      "prefix": "arc",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "outputPath": "dist/arc",
+            "index": "projects/arc/src/index.html",
+            "main": "projects/arc/src/main.ts",
+            "polyfills": ["zone.js"],
+            "tsConfig": "projects/arc/tsconfig.app.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "projects/arc/src/favicon.ico",
+              {
+                "glob": "**/*",
+                "input": "projects/arc-lib/src/lib/assets/",
+                "output": "/assets/"
+              }
+            ],
+            "styles": [
+              "./node_modules/@angular/material/prebuilt-themes/indigo-pink.css",
+              "node_modules/eva-icons/style/scss/eva-icons.scss",
+              "node_modules/@nebular/theme/styles/prebuilt/dark.css",
+              "projects/arc/src/styles.scss"
+            ],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "1mb",
+                  "maximumError": "2mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "fileReplacements": [
+                {
+                  "replace": "projects/arc/src/environments/environment.ts",
+                  "with": "projects/arc/src/environments/environment.ts"
+                }
+              ],
+              "index": {
+                "input": "projects/arc/src/index.html",
+                "output": "index.html"
+              },
+              "optimization": false,
+              "outputHashing": "all",
+              "sourceMap": false,
+              "namedChunks": false,
+              "extractLicenses": true,
+              "vendorChunk": false,
+              "buildOptimizer": false,
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "8mb",
+                  "maximumError": "8mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "100kb",
+                  "maximumError": "500kb"
+                }
+              ]
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "browserTarget": "arc:build"
+          },
+          "configurations": {
+            "production": {
+              "browserTarget": "arc:build:production"
+            },
+            "development": {
+              "browserTarget": "arc:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "arc:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "polyfills": ["zone.js", "zone.js/testing"],
+            "tsConfig": "projects/arc/tsconfig.spec.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "projects/arc/src/favicon.ico",
+              {
+                "glob": "**/*",
+                "input": "projects/arc-lib/src/lib/assets/",
+                "output": "projects/arc-lib/src/lib/assets/"
+              }
+            ],
+            "styles": [
+              "projects/arc/src/styles.scss",
+              "projects/arc-lib/src/lib/theme/styles/index.scss"
+            ],
+            "scripts": []
+          }
+        }
+      }
+    },
+    "arc-lib": {
+      "projectType": "library",
+      "root": "projects/arc-lib",
+      "sourceRoot": "projects/arc-lib/src",
+      "prefix": "lib",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:ng-packagr",
+          "options": {
+            "project": "projects/arc-lib/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/arc-lib/tsconfig.lib.prod.json"
+            },
+            "development": {
+              "tsConfig": "projects/arc-lib/tsconfig.lib.json"
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "tsConfig": "projects/arc-lib/tsconfig.spec.json",
+            "polyfills": ["zone.js", "zone.js/testing"]
+          }
+        }
+      }
+    }
+  },
+  "defaultProject": "arc",
+  "cli": {
+    "analytics": "dcf534a6-f2c3-4c9c-99f0-3de66c9162da"
+  }
+}