Skip to content

Build Process

Maximilian Krug edited this page Jul 13, 2024 · 4 revisions

Build Process

This document is a short description on how to build the siemens Xcelerator demo project.

The following picture shows the main steps of the build process. The following subsections will further explain each of the steps. Project Architecture

PNPM

PNPM is our package manager, it works nearly identical to NPM. PNPM is a package manager used for managing the dependencies and installations.

The first command in the build process is:

PNPM install

NX Tests

The Nx workspace for managing the monorepository enables us to use view commands to start all tests.

The command for the tests:

nx run-many -t test 

Similarly, the ESlint test can be started, ESlint checks for coding and format conventions.

The command for starting the ESlint tests is:

nx run-many -t lint

NX Build

NX can also be used to build the Workspace, therefore we need to run the command:

nx run-many -t build

Docker

Deployment is possible using docker compose, this will containerize and build the front and backend. This enables to publish the project. Currently, there is no infrastructure for the project in the planning.

The command is:

docker compose up

Further information

Project Architecture

Clone this wiki locally