Skip to content

Commit 82aeda3

Browse files
committed
fix:\updated changes in reaadme
1 parent e1f9cad commit 82aeda3

File tree

5 files changed

+19
-44
lines changed

5 files changed

+19
-44
lines changed

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Angular Boilerplate
1+
#### ANGULAR BOILERPLATE
22
[![Version](https://img.shields.io/badge/@angular/core-v14-brightgreen)](http://commitizen.github.io/cz-cli/)
33

44
<!-- DOCUMENTATION -->
@@ -13,26 +13,18 @@
1313

1414
Following are the steps to get started with it:
1515

16-
# Prerequisite
16+
# Usage
1717

18-
#### Step 1: Install NodeJS
19-
20-
Install the latest LTS version from here: https://nodejs.org/en/download/.
21-
22-
#### Step 2: Install Angular CLI
23-
24-
Angular provides a very useful command line utility that help in easily developing angular applications, models, services, etc. as a boilerplate, which saves a lot of time.
18+
#### Step 1:Clone the boilerplate project repository to your local machine
2519

2620
```sh
27-
npm install -g @angular/cli
21+
https://github.com/sourcefuse/angular-boilerplate
2822
```
2923

30-
#### step 3 : Install Nebular
31-
32-
Similarly Angular also Provides Nebular which supports init configuration with Angular Schematics. This means you can simply add it to your project, and Angular Schematics will do the rest
24+
#### Step 2: Install the project dependencies by running the following command
3325

3426
```sh
35-
ng add @nebular/theme
27+
npm install
3628
```
3729

3830
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:
@@ -64,7 +56,7 @@ As can be seen above, scaffold has initialized and set up a lot, such as:
6456
6. The folder named `projects`:
6557
- Projects will hold the multi application pattern and will always be completely independent
6658

67-
#### Step 4: The Structure is main project folder
59+
#### The Structure is main project folder
6860

6961
```
7062
PROJECTS
@@ -84,25 +76,21 @@ PROJECTS
8476
- This boilerplate arc project is a project set up that can be easily altered to create new projects.
8577
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.
8678

87-
FOR further reference you can refer [here]()
88-
8979
2. Arc-Lib
9080
- 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.
9181

92-
For further reference you can refer [here](../arc-sf/projects/arc-lib/README.md)
93-
82+
For further reference you can refer [Here](Projects/arc-lib/README.md)
9483

95-
### Step 5: Start the Server
9684

97-
Go to the terminal and change the directory into your service folder:
85+
### Step 3: Start the Server
9886

9987
```sh
10088
ng serve
10189
```
10290

103-
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.
91+
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.
10492

105-
### Step 6: Build the Application
93+
### Build the Application
10694

10795
To build the project. The build artifacts will be stored in the `dist/` directory.
10896

projects/arc-lib/README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# arc Shared-Library
1+
#### ARC-LIBRARY
22

33
# Description
44

@@ -97,15 +97,16 @@ Store module provides `store-keys.enum`,`user-session-store.service` and`system-
9797

9898
- In order to use it ,one can incorporate `ToasterService` provided in theme module which provides methods to display toast messages using the NbToastrService from the `@nebular/theme package`. The service has methods to show different types of toast messages such as success, info, warning, error, and default, and allows customization of the toast messages through an optional config parameter. The `ToasterAdapterService` is used to adapt the config object to the format expected by the NbToastrService. The service implements the IToaster interface which defines the method signatures for displaying toast messages.
9999

100-
For more detail about Core Module, refer [here](./src/lib/core/readme.md)
100+
For more detail about Core Module, refer [Here](/projects/arc-lib/src/lib/core/readme.md)
101101

102102
## Theme:
103103

104104
Theme module in arc is usually used in conjunction with Nebular, Nebular is a customizable Angular UI Library and styles designed to create a consistent, modern user interface. Nebular includes a set of pre-defined themes, but you can also create your own custom themes also.
105105

106106
Also, provides methods to register icon packs with the NbIconLibraries service. The `NbIconLibraries` service is a part of the nebular UI library and is used to manage icon libraries and packs.
107107

108-
For more details about Theme Module,refer [here](./src/lib/theme/readme.md)
108+
For more details about Theme Module,refer [Here](/projects/arc-lib/src/lib/theme/readme.md)
109+
(./src/lib/theme/readme.md)
109110

110111
# Components:
111112

@@ -133,19 +134,5 @@ For more details about Theme Module,refer [here](./src/lib/theme/readme.md)
133134
- The auth component typically includes a login as well as a registration form for new users to create
134135
an account. The component may also handle password reset functionality and provide options for users to manage their accounts
135136

136-
For more details about Components ,refer [here](./src/lib/components/readme.md)
137+
For more details about Components ,refer [Here](/projects/arc-lib/src/lib/components/readme.md)
137138

138-
# Usage
139-
140-
Clone the boilerplate project repository to your local machine:
141-
`https://github.com/sourcefuse/angular-boilerplate`
142-
143-
Install the project dependencies by running the following command in your terminal:
144-
145-
```sh
146-
npm install
147-
```
148-
149-
# Further help
150-
151-
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.

projects/arc-lib/src/lib/components/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Components
1+
#### COMPONENTS
22

33
1. Gantt
44

projects/arc-lib/src/lib/core/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Core Module
1+
#### CORE MODULE
22

33
The Core Module provides essential services and functionality that will be used throughout the
44
application. It imports various Angular and third-party modules including basic modules which we need for an application and this module also imports NgxPermissionsModule, ApiModule, LocalizationModule, StoreModule, ToasterModule etc.The module extends EnsureModuleLoadedOnce class to ensure that it is only loaded once in the application.

projects/arc-lib/src/lib/theme/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Theme module
1+
#### THEME MODULE
22

33
- Theme module in the boilerplate is usually used in conjunction with Nebular,Nebular is a customizable Angular UI Library and styles designed to create a consistent, modern user interface. Nebular includes a set of pre-defined themes, but you can also create your own custom themes also.
44

0 commit comments

Comments
 (0)