Getting Started With Yuuvis® Project
This repository is the Schematic implementation that serves as a starting point to create a Yuuvis® Client with Angular.
Table of Contents
- Types - Core - Framework - all
With this package you can add the basic implementation for a Yuuvis® Client with the Core services package that provides all necessary services to get you started the Yuuvis® Backend and Framework which provides prepared and styled components to perfectly visualize the data.
An Angular 10 or higher and AngularCli 10 or higher project is required.
We recommend both in version 11.
For Angular project below 10 please use @firstname.lastname@example.org
BEFORE YOU INSTALL: please read the prerequisites The installation of any required additional packages is not required.
Add Yuuvis® to your project
ng add @yuuvis/project
ng add @yuuvis/project --type=core
ng add @yuuvis/project --type=framework
--type- "core", "framework"
--project- name of the project the library will be added to
--skipInstall- Skip Installing npm Packages
--disableIvy- Disable Ivy in Angular Compileroptions.
--px-password- password for proxy connection.
--px-target- proxy endpoint.
--px-user-name- username for proxy connection.
ng new new-project cd newProject ng add @yuuvis/project --type=framework --project=new-project
Each Library can also be added via the generate command.
ng generate @yuuvis/project:core
ng generate @yuuvis/project:framework
ng new new-project cd newProject ng generate @yuuvis/project:core
All types will add proxy, NginX configuration and Docker files to the Project root Directory. And imports to the RootModule.
Framework also adds base config file and default Translations to the Application assets.
Will install both packages and configure the application accordingly.
The documentation for the developers.