@netgrif/components-core
Version:
Netgrif Application engine frontend core Angular library
98 lines (61 loc) • 6.38 kB
Markdown
# Netgrif Components Core library
[](https://netgrif.com/engine/license)
[](https://www.angular.io/)
[](https://www.npmjs.com/package/@netgrif/components-core)
[](https://www.npmjs.com/package/@netgrif/components-core)
[](https://petriflow.com)
[](https://github.com/netgrif/components/releases)
[](https://github.com/netgrif/components/actions/workflows/master-build.yml)
[](https://sonarcloud.io/summary/new_code?id=netgrif_components)
[](https://sonarcloud.io/dashboard?id=netgrif_components)
[](https://snyk.io/test/github/netgrif/components)
Netgrif Components Core library is an Angular library to build an applications connected with Netgrif Application Engine.
The library provides all necessary tools for working with processes and applications deployed 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](https://petriflow.com)
* Documentation: [https://components.netgrif.com](https://components.netgrif.com)
<!-- * Getting Started: [https://components.netgrif.com/get_started](https://components.netgrif.com/get_started) -->
* Issue Tracker: [Github issues](https://github.com/netgrif/components/issues)
* Compodoc: [@netgrif/components-core compodoc](https://components.netgrif.com/#/compodoc/components-core)
* Typedoc: [@netgrif/components-core typedoc](https://components.netgrif.com/#/typedoc/components-core)
* License: [NETGRIF Community License](https://github.com/netgrif/components/blob/master/LICENSE)
This library consist of services for controlling an application and abstract classes for components implementation
but with no html or css parts.
## Requirements
The Library is implemented as Angular library. With Angular dependencies there are several others to complement functionality and range of components available for
NAE based applications.
The library has defined peer dependencies that are not installed automatically with npm. You can install dependencies with this command:
```shell
npm i -S @angular-material-components/datetime-picker@4 @angular-material-components/moment-adapter@4 @angular/animations@10 @angular/cdk@10 @angular/common@10 @angular/compiler@10 @angular/core@10 @ngbracket/ngx-layout@10 @angular/forms@10 @angular/material@10 @angular/material-moment-adapter@10 @angular/platform-browser@10 @angular/platform-browser-dynamic@10 @angular/router@10 @covalent/core@3 @covalent/highlight@3 @covalent/markdown@3 @covalent/text-editor@3 @ngx-translate/core@13 @ngx-translate/http-loader@6 @schematics/angular@10 angular-resizable-element@3 angular-resize-event@2 angular2-hotkeys@2 hammerjs@2 json-schema-to-typescript@8 jszip@3 moment@2 natural-orderby@2 rxjs@6 zone.js@0.10
```
## Installation
To install the library just type:
```shell
npm i -S @netgrif/components-core
```
With only the core library you can implement own web components, with custom design, with compatibility to NAE applications.
If you don't want to create own implementation of web components, check out our default set of components in [@netgrif/components](https://github.com/netgrif/components/blob/master/projects/netgrif-components/README.md) library.
## Usage and configuration
To use the library, it must be configured as Angular application.
Firstly, create new Angular project. We recommend following [official guide](https://angular.io/guide/setup-local).
### NAE.json
To configure NAE application more easily the library 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.
You can find [minimal nae.json configuration here](docs/configuration/nae-minimal.json).
<!-- You can read more on how to configure complete [nae.json here](https://components.netgrif.com/#/configuration). -->
For easier startup clone [template project for NAE frontend application](https://github.com/netgrif/nae-frontend-application-starter)
<!-- For more information please read instructions in [Get Started](https://components.netgrif.com/#/get_started) -->
## Other projects
### Application Engine
[Netgrif Application Engine](https://github.com/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](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)](https://github.com/netgrif/ncli).
## Reporting issues
If you find a bug, let us know at [Issue page](https://github.com/netgrif/components/issues). First, please read our [Contribution guide](https://github.com/netgrif/components/blob/master/CONTRIBUTING.md)
## License
The software is licensed under NETGRIF Community license. You may be found this license at [the LICENSE file](https://github.com/netgrif/components/blob/master/LICENSE) in the repository.