{"id":19763510,"url":"https://github.com/netgrif/etask-frontend-starter","last_synced_at":"2026-01-02T20:09:40.553Z","repository":{"id":214256089,"uuid":"735648771","full_name":"netgrif/etask-frontend-starter","owner":"netgrif","description":"NAE based process application to help you start creating you own digital environment.","archived":false,"fork":false,"pushed_at":"2024-05-17T10:44:03.000Z","size":194,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-22T04:12:48.662Z","etag":null,"topics":["angular","business-processes","nae","netgrif","petriflow","typescript"],"latest_commit_sha":null,"homepage":"https://etask.netgrif.cloud","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netgrif.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-25T17:16:17.000Z","updated_at":"2024-03-10T23:52:08.000Z","dependencies_parsed_at":"2024-01-23T17:55:21.247Z","dependency_job_id":"86695215-0b76-4366-b3a5-3c0bda0db742","html_url":"https://github.com/netgrif/etask-frontend-starter","commit_stats":null,"previous_names":["netgrif/etask-frontend-starter"],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgrif%2Fetask-frontend-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgrif%2Fetask-frontend-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgrif%2Fetask-frontend-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgrif%2Fetask-frontend-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netgrif","download_url":"https://codeload.github.com/netgrif/etask-frontend-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243738985,"owners_count":20340002,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","business-processes","nae","netgrif","petriflow","typescript"],"created_at":"2024-11-12T04:09:32.041Z","updated_at":"2026-01-02T20:09:40.484Z","avatar_url":"https://github.com/netgrif.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# eTask Frontend Starter\n\n[![License](https://img.shields.io/badge/license-NETGRIF%20Community%20License-green)](https://netgrif.com/license)\n[![Angular](https://img.shields.io/github/package-json/dependency-version/netgrif/etask-frontend-starter/@angular/core?color=red)](https://www.angular.io/)\n[![NAE](https://img.shields.io/github/package-json/dependency-version/netgrif/etask-frontend-starter/@netgrif/components-core?color=blue)](https://www.angular.io/)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/netgrif/etask-frontend-starter?sort=semver\u0026display_name=tag)](https://github.com/netgrif/etask-backend-starter/releases)\n\neTask is a process-based application build\nwith [Netgrif Application Engine (NAE)](https://github.com/netgrif/application-engine).\neTask project is a quick way to start working with NAE and [Petriflow](https://github.com/netgrif/petriflow) processes\nwithout a need to set up project from scratch.\n\neTask frontend is implemented with Angular framework and it depends on default NAE components library.\nYou are free to use your own components that are based on [@netgrif/components](https://github.com/netgrif/components).\n\nIt helps if you are familiar with Angular Framework, Typescript, CSS and HTML, but it is not necessary as this starter\nproject already contains some predefined views and navigation items, which are suitable for interacting with your\nprocesses.\n\n## Requirements\n\nFrontend application has some requirements for runtime environment. The following table is summary of requirements to\nbuild and run the application for development.\n\n| Name                              | Version  | Description                                               | Recommendation                                                  |\n|-----------------------------------|----------|-----------------------------------------------------------|-----------------------------------------------------------------|\n| [Angular CLI](https://angular.io) | 13.+     | TypeScript-based web application framework                | ```npm i -g @angular/cli@13.3.1\"```                             |\n| [NodeJs](https://nodejs.org/en/)  | 16+, 18+ | JavaScript runtime built on Chrome's V8 JavaScript engine | [NodeJs 18.19.0](https://nodejs.org/download/release/v18.19.0/) |\n| [NPM](https://www.npmjs.com)      | 9+       | Node Package Manager                                      | Compatible version comes with NodeJs                            |\n\n## Installation\n\neTask can be used as a starting project for your NAE application, or it can be run as is and deploy Petriflow\nprocesses at runtime.\n\n### Starter project\n\nThis project can be used as a base to your NAE application. Before you start coding please consider doing following\nsteps to personalize the project:\n\n- In [package.json](package.json), change the value of ```name``` attribute to name of your application\n\nAs it is an Angular project, there is a file called ```package.json``` in root folder, which contains information about\nproject and application, script definitions, dependencies and their versions.\n\nFirst step is to install the dependencies using the NPM package manager. Using terminal, navigate to the root folder (\nwhere the ```package.json``` is saved) and run ```npm install --legacy-peer-deps``` command. This will scan the ```package.json``` file and\ninstall the dependencies from NPM repositories.\n\nThe second step is to build the application using Angular CLI (Command Line Interface). This can be done using terminal\nwhen you are in the root folder of the project running ```ng build``` command. This will create a ```dist``` folder,\nthat contains the build of application. This build then can be moved to a web server (e.g. Apache or Nginx).\n\nTo run the application locally you can use ```ng serve``` command, that runs an embedded server and serves the\napplication to localhost. Port of the application can be changed using ```--port``` option. The default port is 4200.\n\n#### NAE.json\n\nThe frontend application consist of side menu and a views for the application. There are some predefined views for\nprocesses, cases, tasks and user management. Side menu items are loaded from the [eTask application server](https://github.com/netgrif/etask-backend-starter).\n\nTo configure NAE application more easily the libraries use file ```nae.json``` that is placed in root of the project.\n```nae.json``` defines global application configuration like urls to backend resources, services' configurations,\nrouting and views.\n\n### Run in web server\n\neTask frontend application build is distributed with every release. You can download is as a [release artifact](https://github.com/netgrif/etask-frontend-starter/releases/latest),\nextract it from the zip archive and run it in web server of your choice.\nContent of the release artifact are only static files to be served be a web server and run in the client browser.\nThe project includes example of [nginx configuration](default.nginx.conf).\n\n### Run as a container\n\neTask frontend application is also published as [Docker image](https://hub.docker.com/r/netgrif/etask-frontend) available via Docker hub.\nDocker image is running nginx web server to serve eTask frontend application. You can run it directly with docker:\n\n```shell\ndocker pull netgrif/etask-frontend:latest\ndocker run -p 80:80 netgrif/etask-frontend:latest\n```\n\nor with docker-compose file:\n\n```yaml\nversion: \"3.3\"\nservices:\n  etask:\n    image: netgrif/etask-frontend:latest\n    ports:\n      - \"80:80\"\n```\n\n#### Configuration\n\nThe application can be configured using environment variables. Available variables are in table below:\n\n| Variable         | Type    | Default | Description                                                                                                       |\n|------------------|---------|---------|-------------------------------------------------------------------------------------------------------------------|\n| AUTO_RESOLVE_URL | Boolean | true    | Enable/Disable auto-resolving URL of eTask application server based on domain that this app is run.               |\n| LOG_LEVEL        | String  | DEBUG   | Log level of frontend logger. Default logger pushes to browser console.  Allowed values: DEBUG, INFO, WARN, ERROR |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetgrif%2Fetask-frontend-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetgrif%2Fetask-frontend-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetgrif%2Fetask-frontend-starter/lists"}