Skip to content

Commit 4a57005

Browse files
Update README.md
1 parent 1d962e8 commit 4a57005

File tree

1 file changed

+13
-23
lines changed

1 file changed

+13
-23
lines changed

README.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
1-
# AngularAvatarGettingStarted
1+
# Getting Started with the Angular Avatar Component
2+
A quick-start project that contains code to create and configure the Syncfusion Angular Avatar component. It includes a code snippet for different sizes and types of avatars. It also includes a code snippet for integrating the Avatar with the other UI components.
23

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.3.
4+
Refer to the following documentation to learn about the Angular Avatar component:
5+
https://ej2.syncfusion.com/angular/documentation/avatar/getting-started
46

5-
## Development server
7+
Check out this online example of the Angular Avatar component:
8+
https://ej2.syncfusion.com/angular/demos/#/bootstrap5/avatar/default
69

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
10+
## Project prerequisites
11+
Make sure that your machine has the following setup before starting to work on this project.
12+
* [Visual Studio Code](https://code.visualstudio.com/download )
13+
* [NodeJS](https://nodejs.org/en/download)
14+
* [Angular 6+](https://angularjs.org/)
815

9-
## Code scaffolding
10-
11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
12-
13-
## Build
14-
15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
16-
17-
## Running unit tests
18-
19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
20-
21-
## Running end-to-end tests
22-
23-
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.
24-
25-
## Further help
26-
27-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
16+
## How to run this application
17+
To run this application, you need to first clone the `getting-started-with-the-angular-avatar-component` repository and then open it in Visual Studio Code. Now, simply build and run your project using `npm start` command to view the output.

0 commit comments

Comments
 (0)