This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 857201. The European Commission assumes no responsibility for any content of this repository.

Data transfer objects

This projekt contains definitions of data transfer objects (DTOs). DTOs describe the structure of data exchanged between microservices of the platform.

Install, build

Prerequesits:

• NPM
• Node.js

Install in your project:

Run:

$ npm i -S git+https://git@github.com/IRT-Open-Source/5gv-dto.git

Build:

Note: This library is used by services which are build and run by the up.sh script of the Platform project. Typically you would only need to run the following commands, if you need to make changes to this project.

Clone this repository, change into its root directory and run following command to install its dependencies:

$ npm i

Build JavaScript modules from typescript source:

$ npx tsc

TODOs

Build on NPM postinstall

Currently, the scripts in directory /dist are built from the sources using the typscript compiler tsc and checked into the git repository. This is considered to be a bad style. For one it creates unnecessary overhead (memory + files to track). Much more important, it is not obvious if the files in /dist correspond to the current development status of the sources -- no single source of truth. Actually, the files in /dist should be built after the installation via NPM at the user's site, for example by a postinstall script defined in the package.json. However, this approach could not be implemented successfully so far. In consuming services, errors were encountered during build of the docker images when NPM attempted to resolve the dependencies or to build the scripts.