Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 2.73 KB

README.md

File metadata and controls

73 lines (46 loc) · 2.73 KB

Sample Client Applications

back to main project page

The library implemented in the PoC (see src folder) and deployed as a NPM package can be used in different ways by any/multiple client projects.

See the list of provided example applications below.

Table-of-Content

Screenshots

  • Node Preview:
    node preview
  • CLI Preview:
    node preview
  • Browser Preview:
    node preview
  • Angular Preview:
    node preview

Installation

standard installation

In most of the case, the client project needs to install the NPM package as a dependency.

The one-ts-for-all should be integrated in the client project to augment its functionality, hence it should be installed as a productive dependency, hence:

npm install --save @khatastroffik/one-ts-for-all

Note: In a real scenario, you'd replace the name of the installed package above with the adequate name for the library of your choice.

alternative installation

Alternatively, the client project could download the library from a Source-Code Repository (e.g. use the present repository download file) and manually link/integrate the library files in the client project wherever needed. Cloning the library and installing the cloned repository locally is also a possible alternative.

These 'loose" installation procedures aren't recommanded, though! Hence, they're not documented in detail here.

Use Cases

Usage as a CommonJS module in a node project

goto 'NodeJS' Sample Project

Usage as EcmaScript* module in a web application

goto 'Browser' Sample Project

Usage as Typescript module in an Angular (Typescript) application

goto 'Angular' Sample Project