netgrif / components

Netgrif Components Frontend libraries for creating NAE single-page applications.

Netgrif Components libraries

Netgrif Components is an Angular library for creating SPA (Single-page application) compatible with Netgrif Application Engine. The library provides all necessary tools for creating refined frontend application into NAE environment, and to create own library of Angular web components to incorporate your own personal design to the platform.

• Petriflow low-code language: http://petriflow.com
• Documentation: https://components.netgrif.com

• Issue Tracker: Github issues
• Compodoc: @netgrif/components compodoc, @netgrif/components-core compodoc
• Typedoc: @netgrif/components typedoc, @netgrif/components-core typedoc
• License: NETGRIF Community License

In this repository are 3 projects:

• @netgrif/components-core - Core library of services, factories and abstract classes of components.
• @netgrif/components - Library of angular components implementing classes from core library.
• Examples App - Simple application to demonstrate and test individual components.

Requirements

The Libraries are implemented as Angular libraries. With Angular dependencies there are several others to complement functionality and range of components available for NAE based applications. The components library is based upon Angular Material components to make it easier to derived and implement own set of components but still keep the functionality and compatibility with Application Engine.

The library has defined peer dependencies that are not installed automatically with npm. You can install dependencies with this command:

npm i -S @angular-material-components/[email protected] @angular-material-components/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @angular/[email protected] @covalent/[email protected] @ngx-translate/[email protected] @ngx-translate/[email protected] @schematics/[email protected] @swimlane/[email protected] @types/[email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]

Installation

To install complete NAE frontend experience you must install the core library and components library:

npm i -S @netgrif/components-core @netgrif/components

If you want to developer own set of NAE components, just install the core library, and you can start developing.

Usage and configuration

To start building your NAE web application, it must be configured as Angular application and as NAE application as well.

Firstly, create new Angular project. We recommend following official guide.

NAE.json

To configure NAE application more easily the libraries use file nae.json that is placed in root of the project. nae.json defines global application configuration like urls to backend resources, services' configurations, routing and views.

You can find minimal nae.json configuration here.

For easier startup clone template project for NAE frontend application

Other projects

Application Engine

Netgrif Application Engine is workflow management system powered by low-code language Petriflow written in Java. Application Engine can run as a standalone java application, as a docker image, or you can embed it to your Java/Spring Boot project.

Application Builder

For creating processes in Petriflow language try our free Application Builder on https://builder.netgrif.com. You can start from scratch or import existing process in BPMN 2.0 and builder automatically converts it into Petriflow.

NCLI (Coming soon)

If you need help with setting up project or looking for tool to automate your developer work with NAE based applications, take a look on NCLI (Netgrif Command Line Interface).

Reporting issues

If you find a bug, let us know at Issue page. First, please read our Contribution guide

License

The software is licensed under NETGRIF Community license. You may be found this license at the LICENSE file in the repository.