Boilerplate for an Angular 14 micro-lc parcel. It implements the necessary features to work both standalone and in micro-lc.
First thing you need to do is install the dependencies running
npm installOnce you have the dependencies in place, run
npm run startto spin up the application.
Tests can be run with
npm run coverageTo make the internal routing work in micro-lc, a custom script that removes the <base> tag from the generated HTML has
to be executed at the end of the build process.
If you don't whish to execute this step, simply change the build script in the package.json:
- 8 "build": "ng build && node plugins/post-html.js",
+ 8 "build": "ng build",Warning
If you change the output directory, remember to change line 4 of the script (located in
plugins/post-html.js) accordingly.
Applications build with this template can be used as-is in micro-lc as parcels.
An example configuration may be:
{
"applications": {
"angular14-parcel": {
"integrationMode": "parcel",
"route": "./angular14-parcel/", // <-- must have the ending "/", should have the starting "."
"entry": "/my-micro-lc-angular14-parcel/", // <-- must have the ending "/"
"injectBase": true // <-- must be "true" if hash routing is not used
}
}
}The internal routing of the application is already set up to work in micro-lc, meaning that the base url of the internal
routes is dynamically computed on the bases of micro-lc <base>, as explained in the
official documentation.
Note
If you whish to use a hash router in your application, change
app-routing.module.tsfile as such:- 17 imports: [RouterModule.forRoot(routes)], + 17 imports: [RouterModule.forRoot(routes, { useHash: true })], - 19 providers: [{ provide: APP_BASE_HREF, useValue: baseUrl() }] + 19
To correctly load assets in micro-lc, they should be put in src/assets/ folder, and referenced using the assetUrl
pipe.
A running example can be found in the Home component:
<img alt="logo" class="app-logo" [src]="'angular-logo.svg' | assetUrl" />Angular applications need zone.js library to run, which
is not bundled in micro-lc. Therefore, you need to import it as a <script> in you micro-lc entrypoint before any
micro-lc related module.
<!DOCTYPE html>
<html lang="en">
<head>
[...]
<script type="module" src="https://cdn.jsdelivr.net/npm/[email protected]/dist/zone.min.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@micro-lc/orchestrator@latest/dist/micro-lc.production.js"></script>
</head>
[...]
</html>Warning
zone.jsis also imported in the entrypoint of this application to make it work in development mode. Whereas it is advisable to remove it before bundling for production, the import it can be kept as long as the version matches the one imported in micro-lc.
This walkthrough will explain you how to correctly create a micro-lc Angular 14 plugin from the DevOps Console.
Access your Mia-Platform DevOps Console, create a new project, and go to the Design area.
From the Design area of your project, select Microservices and then create a new one, you have now reached Mia-Platform Marketplace! In the marketplace you will see a set of Examples and Templates that can be used to set-up microservices with a predefined and tested function.
For this walkthrough select the following template: micro-lc Angular 14 Plugin Template.
Give your microservice the name you prefer, in this walkthrough we'll refer to it with the following name: micro-lc-angular14-plugin-template. Then, fill the other required fields and confirm that you want to create a microservice.
A more detailed description on how to create a Microservice can be found in Microservice from template - Get started section of Mia-Platform documentation.
In order to access to your new microservice it is necessary to create an endpoint that targets it.
In particular, in this walkthrough you will create an endpoint to your microservice micro-lc-angular14-plugin-template. To do so, from the Design area of your project select Endpoints and then create a new endpoint.
Now you need to choose a path for your endpoint and to connect this endpoint to your microservice. Give to your endpoint the following path: /micro-lc-angular14. Then, specify that you want to connect your endpoint to a microservice and, finally, select micro-lc-angular14-plugin-template.
Step 3 of Microservice from template - Get started section of Mia-Platform documentation will explain in detail how to create an endpoint from the DevOps Console.
After having created an endpoint to your microservice you should save the changes that you have done to your project in the DevOps console.
Remember to choose a meaningful title for your commit (e.g 'created service micro_lc_angular14_plugin'). After some seconds you will be prompted with a popup message which confirms that you have successfully saved all your changes.
Step 4 of Microservice from template - Get started section of Mia-Platform documentation will explain how to correctly save the changes you have made on your project in the DevOps console.
Once all the changes that you have made are saved, you should deploy your project through the DevOps Console. Go to the Deploy area of the DevOps Console.
Once here select the environment and the branch you have worked on and confirm your choices clicking on the deploy button. When the deploy process is finished you will receive a pop-up message that will inform you.
Step 5 of Microservice from template - Get started section of Mia-Platform documentation will explain in detail how to correctly deploy your project.
Now, if you launch the following command on your terminal (remember to replace <YOUR_PROJECT_HOST> with the real host of your project):
curl <YOUR_PROJECT_HOST>/micro-lc-angular14you should see a Angular-based webpage.
Congratulations! You have successfully learnt how to use our micro-lc Angular 14 Plugin Template on the DevOps Console!