Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md - Angular Boilerplate #42

Merged
merged 9 commits into from
Mar 25, 2024
42 changes: 11 additions & 31 deletions templates/angular-boilerplate/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,24 @@
# Angular Boilerplate

The Azion **Angular Boilerplate** is designed to simplify and enhance the deployment process for Angular.js applications directly on the edge of the network.
The **Angular Boilerplate** is designed to simplify and enhance the deployment process for Angular.js applications directly on the edge of the network.

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 via Azion Real-Time Manager (RTM), check the [How to deploy edge applications with the Angular Boilerplate](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) guide.

This template uses Angular CLI version `16.1.3`.

## Usage Information

To start using this template, you need to:

1. Access [Azion Real-Time Manager (RTM)](https://manager.azion.com/).
- If you don’t have an account yet, create a new one [by visiting the sign-up page](https://manager.azion.com/signup/).
2. On the homepage, select the **Start with a template** option.
3. Find the **Angular boilerplate** card and select it.
4. Click the **Settings tab** to configure the template.

## Settings

To successfully deploy this template, you must provide the information to configure your Azion application. Fields identified with an asterisk are mandatory.

* **Application Name***: the name of your edge application on Azion.
* **GitHub Personal Token***: your GitHub personal token.
* While generating your GitHub personal token, grant that your scope has the permissions to authorize an OAuth app or a personal token to access to public and private repositories, including read and write access to code. You must also enable the workflow option to allow adding and updating GitHub Actions workflow files.
---

Note that permissions can be scoped either to a user or an organization or to a repository. Read the [Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) documentation for more information.

After filling out the form, click the **Next** button to start the deployment process.

Once the template is deployed, you can edit and update your args and code. However, you'll need to declare secrets on your project's GitHub repository first to complete the second build with these changes. When the second build is completed, you can manage your project with a [continuous deployment workflow](#continuous-deployment).

For a more detailed step-by-step on declaring your secrets and using this template, check the [How to deploy edge applications with the Angular Boilerplate](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) guide for more details.
## Usage Information

## Important
To use this template, you must [sign in on Azion Cosole](https://console.azion.com/login).

To guarantee the optimal performance of this template, it's necessary to activate the following Azion product:
> If you haven't an account, go to the [signup page](https://console.azion.com/signup) to complete the registration.

* [Edge Functions](https://www.azion.com/en/documentation/products/edge-application/edge-functions/#edge-functions-management)
To successfully deploy this template, you will need to provide the information to configure your Azion application, as shown in the **Setting** tab on the template's page.

You need to activate the product separately via RTM. Review the [Azion documentation](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) to do so.
For a more detailed step-by-step on using this template and requirements, check the [How to deploy edge applications with the Angular Boilerplate](https://www.azion.com/en/documentation/products/guides/angular-boilerplate/) guide.

If this product is activated, the execution of this template could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information.
---

## Continuous deployment

Expand Down Expand Up @@ -72,6 +50,8 @@ To do so, open your repository in GitHub. Then, go to **Settings** > **Secrets a

Now your project is ready to work with a continuous deployment workflow, updating instantly any changes in the application or the repository.

---

## Management

Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using [Azion Real-Time Manager (RTM)](https://manager.azion.com/).
Expand All @@ -80,5 +60,5 @@ To manage and edit your edge application’s settings, read the documentation ab

### Custom domain

The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net`. However, you can add a custom domain for users to access your edge application through it. Go to the [Domains](https://www.azion.com/en/documentation/products/edge-application/domains/) documentation to read more about it.
The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net`. However, you can add a custom domain for users to access your edge application through it. Go to the [Domains](https://www.azion.com/en/documentation/products/guides/configure-a-domain/) documentation to read more about it.

Loading