This is a frontend starter project for Netgrif Application Engine to display your NAE based application, manage your processes, cases and tasks.
It helps if you are familiar with Angular Framework, Typescript, CSS and HTML, but it is not necessary as this starter project already contains some predefined views and navigation items, which are suitable for interacting with your processes.
Frontend application has some requirements for runtime environment. The following table is summary of requirements to build, run and use the engine.
| Name | Version | Description | Recommendation |
|---|---|---|---|
| Angular CLI | 13.+ | TypeScript-based web application framework | npm i -g @angular/cli@13.3.1" |
| NodeJs | 12.20+ OR 14.15+ OR 16.10.+ | JavaScript runtime built on Chrome's V8 JavaScript engine | NodeJs 14.19.3 |
| NPM | 6.5.+ OR 7.4.+ | Node Package Manager | Compatible version comes with NodeJs |
This project can be used as a base to your NAE application. Before you start coding please consider doing following steps to personalize project:
- In package.json, change the value of
nameattribute to name of your application
As it is an Angular project, there is a file called package.json in root folder, which contains information about
project and application, script definitions, dependencies and their versions.
First step is to install the dependencies using the NPM package manager. Using terminal, navigate to the root folder (
where the package.json is saved) and run npm install --legacy-peer-deps command. This will scan the package.json file and
install the dependencies from NPM repositories.
The second step is to build the application using Angular CLI (Command Line Interface). This can be done using terminal
when you are in the root folder of the project running ng build command. This will create a dist folder,
that contains the build of application. This build then can be moved to a web server (e.g. Apache or Nginx).
To run the application locally you can use ng serve command, that runs an embedded server and serves the
application to localhost. Port of the application can be changed using --port option. The default port is 4200.
The frontend application consist of side menu and a views for the application. There are some predefined views for processes, cases, tasks and user management. Further views can be added using Angular schematics.
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