This project was generated with Angular CLI version 18.2.1 using the AppShell library (v18.0.1) and Angular Material (v17.0.0).
The AppShell is a framework and foundation to boost the development of modern web applications on the EDP. The framework provides commonly used capabilities in frontend and backend application components.
With the AppShell, we are offering design templates "ready to use" so any platform can optimize the efforts by using our adaptable templates, promoting consistency between platforms but also guaranteeing following the Digital Design System of our company and complying with Web Content Accessibility Guidelines.
In order for a developer to work locally, the file proxy.conf.json needs to be updated to use the proper backend host in the target property.
In addition, the public/config/config.json needs to be updated accordingly. Using a different azure application if needed and also selecting the catalogId.
The catalogId is the result of encoding the relative route of the catalog definition within the bitbucket host that the backend uses. For example, the current value is for: /projects/DSMC/repos/catalog/browse/Catalog.yaml?at=refs/heads/master. If you need to encode a new value, you can run the following command and then paste the value in the config file:
echo /projects/DSMC/repos/catalog/browse/Catalog.yaml?at=refs/heads/master | base64 -w 0
If you have the config.json and the proxy.conf.json files properly configured, the application should work without updating anything else.
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.
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.
Run ng build to build the project. The build artifacts will be stored in the dist/ directory.
Run ng test to execute the unit tests via Karma.
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.
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.
In order to generate a new client, you can update the contents of the openapi.yaml file in the root directory with the latest version of the contract and then execute the script npm run generate-api-client
For detailed instructions on how to use the AppShell library, including available components, their inputs, outputs, and expected parameters, please refer to our comprehensive guide on Confluence.