Skip to content

Latest commit

 

History

History
102 lines (72 loc) · 6.14 KB

README.md

File metadata and controls

102 lines (72 loc) · 6.14 KB
Raw

eTask Frontend Starter

License Angular NAE GitHub release (latest SemVer)

eTask is a process-based application build with Netgrif Application Engine (NAE). eTask project is a quick way to start working with NAE and Petriflow processes without a need to set up project from scratch.

eTask frontend is implemented with Angular framework and it depends on default NAE components library. You are free to use your own components that are based on @netgrif/components.

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.

Requirements

Frontend application has some requirements for runtime environment. The following table is summary of requirements to build and run the application for development.

Name Version Description Recommendation
Angular CLI 13.+ TypeScript-based web application framework npm i -g @angular/[email protected]"
NodeJs 16+, 18+ JavaScript runtime built on Chrome's V8 JavaScript engine NodeJs 18.19.0
NPM 9+ Node Package Manager Compatible version comes with NodeJs

Installation

eTask can be used as a starting project for your NAE application, or it can be run as is and deploy Petriflow processes at runtime.

Starter project

This project can be used as a base to your NAE application. Before you start coding please consider doing following steps to personalize the project:

  • In package.json, change the value of name attribute 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.

NAE.json

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. Side menu items are loaded from the eTask application server.

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.

Run in web server

eTask frontend application build is distributed with every release. You can download is as a release artifact, extract it from the zip archive and run it in web server of your choice. Content of the release artifact are only static files to be served be a web server and run in the client browser. The project includes example of nginx configuration.

Run as a container

eTask frontend application is also published as Docker image available via Docker hub. Docker image is running nginx web server to serve eTask frontend application. You can run it directly with docker:

docker pull netgrif/etask-frontend:latest
docker run -p 80:80 netgrif/etask-frontend:latest

or with docker-compose file:

version: "3.3"
services:
  etask:
    image: netgrif/etask-frontend:latest
    ports:
      - "80:80"

Configuration

The application can be configured using environment variables. Available variables are in table below:

Variable Type Default Description
AUTO_RESOLVE_URL Boolean true Enable/Disable auto-resolving URL of eTask application server based on domain that this app is run.
LOG_LEVEL String DEBUG Log level of frontend logger. Default logger pushes to browser console. Allowed values: DEBUG, INFO, WARN, ERROR