#####################
Frontend
#####################

.. contents::
  :local:
  :depth: 1

Prerequisities
==============

The Management portal Frontend is a `Vue.js <https://vuejs.org/>` application. In order to build and serve the app, the minimum requisites are the following:

- `Node.js >= 18.3 <https://nodejs.org/en/download/package-manager>`__
- `Yarn Package Manager >= 1.22.19  <https://yarnpkg.com/>`__

Installation
============

Install the dependencies:

.. code:: bash

  yarn install

This command will install all the dependencies (Vue.js, mitt, pinia.js, ecc..) from the package.json file inside the project root.


Configuration options
=====================

The API endpoints can be configured from the .env file in the project root (do not edit the .env.production file, unless some config changes has to be done):

- *VUE_APP_API_URL*: API full URL
- *VUE_APP_DOMAINS_ENDPOINT*: Domains service endpoint
- *VUE_APP_DEPLOYMENTS_ENDPOINT*: Deployment service endpoint

The following configurations should be functional even with the local development. Unless you are working with a Keycloak local instance, do not edit this variables:

- *VUE_APP_KEYCLOAK_URL*: Apache Keycloak IAM full URL
- *VUE_APP_KEYCLOAK_CLIENT_ID*: IAM Client ID
- *VUE_APP_KEYCLOAK_REALM*: IAM Realm

The Keycloak configuration is provided from the keycloak.json inside ~/public/keycloak.json
`Here <https://www.keycloak.org/docs/latest/securing_apps/#_javascript_adapter>`__ you can find the documentation about the possible client-side configuration

Developer guide
===============

Serve the app:

.. code:: bash

  yarn serve

Compiles and minifies for production:

.. code:: bash

  yarn build

Lints and fixes files:

.. code:: bash

  yarn lint


Authors
=======

Federico Maria Corazza - DST