Skip to content

Commit 0ed5410

Browse files
committed
fix:/changes in readme Adding Purpose and run
1 parent d14b890 commit 0ed5410

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@
55

66
## Description
77

8-
- The boilerplate using multiple projects in one Angular environment so that the boilerplate help users
9-
to improve code reusability, scalability, maintainability, and customization. It can also help in increase productivity, reduce risks, and improve the quality of application.
10-
11-
- The multiple applications or parts of applications that share common functionality, using multiple
8+
The boilerplate using multiple projects in one Angular environment so that the boilerplate help users
9+
to improve code reusability,maintainability and customization. boilerplate can also help in increase productivity, reduce risks, and improve the quality of application.
10+
The multiple applications or parts of applications that share common functionality, using multiple
1211
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.
1312

14-
Following are the steps to get started with it:
1513

1614
## Usage
1715

@@ -72,6 +70,17 @@ PROJECTS
7270
```
7371

7472
## Projects
73+
74+
### Purpose of the Projectswe have
75+
- Boilerplate use Multi project to avoid duplicate code and easy maintainance this can be used where
76+
we have to maintain multiple projects that have something in common like a user portal and admin portal
77+
Here Boilerplate use "Projects" folder typically serves as a centralized location to organize and store project-related files and resources.
78+
- Boilerplate allows users to Generate new applications at same workspace with following command:
79+
80+
```sh
81+
ng generate application <application-name>
82+
```
83+
7584
1. Arc:
7685
- This boilerplate arc project is a project set up that can be easily altered to create new projects.
7786
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.
@@ -82,7 +91,15 @@ PROJECTS
8291
For further reference you can refer [Here](Projects/arc-lib/README.md)
8392

8493

85-
#### Step 3: Start the Server
94+
#### Step 3: Setup of Starting the Server
95+
96+
- 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.
97+
98+
```typescript
99+
"defaultProject": "arc",
100+
```
101+
102+
#### Step 4: Running Server
86103

87104
```sh
88105
ng serve

0 commit comments

Comments
 (0)