From 50b1bb8e2da3890a8d5ae42d7230e8cb9a54b719 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mathias=20M=C3=BCller?= Date: Fri, 25 Sep 2026 09:53:33 +0200 Subject: [PATCH] documented update dependencies npm script --- readme.md | 65 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/readme.md b/readme.md index 638f8df2..725ec6f9 100644 --- a/readme.md +++ b/readme.md @@ -101,38 +101,39 @@ Therefore, the repository should be initialized in the root folder by running th ## NPM commands -| Command | Description | Remarks | -| --------------------------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- | -| `npm run build` | runs `build` command in all subrepos of workspace | | -| `npm run build-complete` | runs `build` command in all subrepos of workspace, including `test-ci` and `lint` commands | | -| `npm run build:shared-types` | builds package [Shared Types](#use-shared-code) | | -| `npm run build:shared-components` | builds Shared Angular Components(#use-shared-code) | | -| `npm run build:server:electron-win` | builds *ReFlex.TrackingServer* as Electron app packaged for Windows | | -| `npm run build:server:electron-osx` | builds *ReFlex.TrackingServer* as Electron app packaged for OSX (Intel x64) | needs to be run on macOS | -| `npm run build:server:electron-osx-arm64` | builds *ReFlex.TrackingServer* as Electron app packaged for OSX (ARM64) | needs to be run on macOS | -| `npm run build:server:electron-linux` | builds *ReFlex.TrackingServer* as Electron app packaged for Linux (x64) | | -| `npm run build:server:electron-linux-arm64` | builds *ReFlex.TrackingServer* as Electron app packaged for Linux (ARM64) | | -| `npm run build:emulator` | builds Emulator Angular App | | -| `npm run build:emulator:electron-win` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies | -| `npm run build:emulator:electron-osx` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies, needs to be run on macOS | -| `npm run build:emulator:electron-osx-arm64` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies, needs to be run on macOS | -| `npm run build:emulator:electron-linux` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies | -| `npm run build:emulator:electron-linux-arm64` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies | -| `npm run build:example-angular` | builds Angular Template | | -| `npm run build:example-react` | builds React Template | | -| `npm run build:example-vue` | builds Vue.js Template | | -| `npm run build:logging` | builds *Logging* tool | | -| `npm run start:emulator` | build and start *Emulator* Angular app on `localhost:4300` | | -| `npm run start:example-angular` | build and start Angular Template on `localhost:4201` | | -| `npm run start:example-react` | build and start React Template on `localhost:3000` | | -| `npm run start:example-vue` | build and start Vue.js Template on `localhost:8080` | | -| `npm run start:logging` | build and start *Logging* tool on `localhost:4302` | | -| `npm run start:server` | build and start *ReFlex.TrackingServer* tool (only Angular frontend) on `localhost:4200` | Server backend must be started separately | -| `npm run lint:emulator` | executes linter on *Emulator* project | | -| `npm run lint:server` | executes linter on *ReFlex.TrackingServer* project | | -| `npm run test:emulator` | executes tests on *Emulator* project | | -| `npm run test:net-with-report` | executes .NET tests on .NET Solution *ReFlex.sln* and generates report for tests | Currently only compatible with Windows | -| `npm run test:server` | executes tests on *ReFlex.TrackingServer* project | | +| Command | Description | Remarks | +| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `npm run build` | runs `build` command in all subrepos of workspace | | +| `npm run build-complete` | runs `build` command in all subrepos of workspace, including `test-ci` and `lint` commands | | +| `npm run build:shared-types` | builds package [Shared Types](#use-shared-code) | | +| `npm run build:shared-components` | builds Shared Angular Components(#use-shared-code) | | +| `npm run build:server:electron-win` | builds *ReFlex.TrackingServer* as Electron app packaged for Windows | | +| `npm run build:server:electron-osx` | builds *ReFlex.TrackingServer* as Electron app packaged for OSX (Intel x64) | needs to be run on macOS | +| `npm run build:server:electron-osx-arm64` | builds *ReFlex.TrackingServer* as Electron app packaged for OSX (ARM64) | needs to be run on macOS | +| `npm run build:server:electron-linux` | builds *ReFlex.TrackingServer* as Electron app packaged for Linux (x64) | | +| `npm run build:server:electron-linux-arm64` | builds *ReFlex.TrackingServer* as Electron app packaged for Linux (ARM64) | | +| `npm run build:emulator` | builds Emulator Angular App | | +| `npm run build:emulator:electron-win` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies | +| `npm run build:emulator:electron-osx` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies, needs to be run on macOS | +| `npm run build:emulator:electron-osx-arm64` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies, needs to be run on macOS | +| `npm run build:emulator:electron-linux` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies | +| `npm run build:emulator:electron-linux-arm64` | builds *Emulator* as Electron app packaged for Windows (x64) | `npm install` is executed after packaging to restore the dev dependencies | +| `npm run build:example-angular` | builds Angular Template | | +| `npm run build:example-react` | builds React Template | | +| `npm run build:example-vue` | builds Vue.js Template | | +| `npm run build:logging` | builds *Logging* tool | | +| `npm run start:emulator` | build and start *Emulator* Angular app on `localhost:4300` | | +| `npm run start:example-angular` | build and start Angular Template on `localhost:4201` | | +| `npm run start:example-react` | build and start React Template on `localhost:3000` | | +| `npm run start:example-vue` | build and start Vue.js Template on `localhost:8080` | | +| `npm run start:logging` | build and start *Logging* tool on `localhost:4302` | | +| `npm run start:server` | build and start *ReFlex.TrackingServer* tool (only Angular frontend) on `localhost:4200` | Server backend must be started separately | +| `npm run lint:emulator` | executes linter on *Emulator* project | | +| `npm run lint:server` | executes linter on *ReFlex.TrackingServer* project | | +| `npm run test:emulator` | executes tests on *Emulator* project | | +| `npm run test:net-with-report` | executes .NET tests on .NET Solution *ReFlex.sln* and generates report for tests | Currently only compatible with Windows | +| `npm run test:server` | executes tests on *ReFlex.TrackingServer* project | | +| `npm run update:server:dependencies`. | updates `tools/ReFlex.TrackingServer/ClientApp/src/assets/data/package.json` with current npm dependicies and their version info | ### Known issues (NPM commands)