Skip to content

Commit a972548

Browse files
committed
fix: update angular readme
1 parent 756f9e6 commit a972548

File tree

1 file changed

+15
-45
lines changed
  • templates/angular/angular-boilerplate

1 file changed

+15
-45
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,29 @@
1-
# AngularBoilerplate
1+
# Angular Boilerplate
22

3-
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.2.1.
3+
With the **Angular Boilerplate**, you can simplify and enhance the deployment of Angular applications directly on the edge of the network. This template provides an automation solution that encapsulates several steps, from repository management to edge deployment, accelerating and simplifying your workflow.
44

5-
## Development server
5+
This repository is an example of the new GitHub repository created during the deployment. For a more detailed step-by-step to deploy this template through Azion's platform, check the [How to deploy edge applications with the Angular Boilerplate](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) guide.
66

7-
To start a local development server, run:
7+
This template uses Angular CLI version `18.2.11`.
88

9-
```bash
10-
ng serve
11-
```
9+
---
1210

13-
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
11+
## Requirements
1412

15-
## Code scaffolding
13+
Before using this template, you need to:
1614

17-
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
15+
- Have a [GitHub account](https://github.com/signup).
16+
- Every push will be deployed automatically to the main branch in this repository to keep your project updated.
1817

19-
```bash
20-
ng generate component component-name
21-
```
18+
> **Note**: this template uses [Edge Functions](https://www.azion.com/en/documentation/products/build/edge-application/edge-functions/) and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.
2219
23-
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
20+
---
2421

25-
```bash
26-
ng generate --help
27-
```
22+
## Deploy your own
2823

29-
## Building
24+
Deploy your own Angular project with Azion.
3025

31-
To build the project run:
26+
[![Deploy Button](https://www.azion.com/button.svg)](https://console.azion.com/create/angular/angular-boilerplate "Deploy with Azion")
3227

33-
```bash
34-
ng build
35-
```
28+
For a more detailed step-by-step, check the [documentation](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/).
3629

37-
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
38-
39-
## Running unit tests
40-
41-
To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
42-
43-
```bash
44-
ng test
45-
```
46-
47-
## Running end-to-end tests
48-
49-
For end-to-end (e2e) testing, run:
50-
51-
```bash
52-
ng e2e
53-
```
54-
55-
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
56-
57-
## Additional Resources
58-
59-
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.

0 commit comments

Comments
 (0)