#####################################

Walke-Planning-Poker-Data-Model

##################################### The Walke-Planning-Poker-Data-Model artifact is a Typescript library, containing definitions for the communication of the backend and the frontend of the Walke-Planning-Poker-Application.

Build

Building the artifact is easy. Simply perform "npx tsc" in the terminal console to compile the typescript classes. By this, the model classes from the /src directory together with the index definition from "index.ts" are bundled to the artifact and put into the /dist folder.

Deployment

If the compilation of the artifact was successful, the command "npm publish" can be used to publish the artifact to the public. For this an npm-Account is needed. By typing "npm whoami" into the terminal console, it can be checked which user is registerd for npm and therefor under which name the artifact will be published. Because it is not allowed to override a yet published Version of the artifact, before the execution of the "npm publish" command, the data-model version has to be incremented in the package.json file.

Usage

After publication of the data-model-artifact, it can be included into typescript projects (the backend and the frontend) by calling "npm install walke-planning-poker-data-model" in the terminal console there. After installation, it is recommended to set the version of the "walke-planning-poker-data-model" dependency to the last stable version. After that, the model classes can simply be used by using the standard import keyword like import { EstimationMode, GameState, Estimation, Game } from "teams-data-model";