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

• Intro
• Prerequisites
• Installation
• Usage
  • Add Library's
    • Arguments
    • Options
    • Project Walkthrough
  • Add Components
    • Components Walkthrough
• Types - Core - Framework - all
• Documentation
• License

Intro

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.

Prerequisites

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 @yuuvis/[email protected]

Installation

BEFORE YOU INSTALL: please read the prerequisites The installation of any required additional packages is not required.

Usage

Add Library's

Add Yuuvis® to your project

ng add @yuuvis/project

ng add @yuuvis/project --type=core

ng add @yuuvis/project --type=framework

Arguments

• --type - "core", "framework"
• --project - name of the project the library will be added to (default app.module.ts).
• --skipInstall - Skip Installing npm Packages (default false).
• --disableIvy - Disable Ivy in Angular Compileroptions. (default false)

Options

• --px-password - password for proxy connection.
• --px-target- proxy endpoint.
• --px-tenant -proxy tenant.
• --px-user-name - username for proxy connection.

Project Walkthrough

ng new new-project
cd newProject
ng add @yuuvis/project --type=framework --project=new-project

Add Components

Each Library can also be added via the generate command.

ng generate @yuuvis/project:core

ng generate @yuuvis/project:framework

Components Walkthrough

ng new new-project
cd newProject
ng generate @yuuvis/project:core

Types

All types will add proxy, NginX configuration and Docker files to the Project root Directory. And imports to the RootModule.

Core

Framework

Framework also adds base config file and default Translations to the Application assets.

all

Will install both packages and configure the application accordingly.

Documentation

The documentation for the developers.

License

MIT