Update readme

This commit is contained in:
2025-01-29 18:15:23 +01:00
parent 088663d71f
commit 0178840593
2 changed files with 5 additions and 46 deletions

View File

@ -10,50 +10,10 @@ To start a local development server, run:
ng serve ng serve
``` ```
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. ## Generate code after API changes
## Code scaffolding When the API is changed, the client source code must be regenerated.
Angular CLI includes powerful code scaffolding tools. To generate a new component, run: 1. Install the CLI `npm install -g @openapitools/openapi-generator-cli`
1. Download the latest OpenAPI spec file from the API repository. **Please don't commit it!**
```bash 1. Run `openapi-generator-cli generate -i [path_to_openapi.yml] -g typescript-angular -o src/gen/`. **Commit those changes**
ng generate component component-name
```
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
```bash
ng generate --help
```
## Building
To build the project run:
```bash
ng build
```
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.
## Running unit tests
To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
```bash
ng test
```
## Running end-to-end tests
For end-to-end (e2e) testing, run:
```bash
ng e2e
```
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
## Additional Resources
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.

View File

@ -1,5 +1,4 @@
.gitignore .gitignore
.openapi-generator-ignore
README.md README.md
api.module.ts api.module.ts
api/api.ts api/api.ts