npm package: @frabattista/ux-core
Description: > Name of the High Level Architecture Module this repository refers to. Pick one of the names listed in the Confluence page [(SRM) HLA diagram](https://sdp.finconsgroup.com/confluence/x/ZZ5TAQ).
Author: Antonio Papalillo
Latest version: 0.1.1

## High Level Architecture - Module

> Name of the High Level Architecture Module this repository refers to. Pick one of the names listed in the Confluence page [(SRM) HLA diagram](https://sdp.finconsgroup.com/confluence/x/ZZ5TAQ).

## Summary

> Short description of the functionalities provided by this piece of software in the context of the Smart Component.

## Link to the interface agreements

> For each available interface, list the pair `type - agreement` where:
> * `type` is one the items below
>    * Command-Line Interface (CLI)
>    * Graphical-User Interface (GUI)
>    * GraphQL API (use [OpenAPI 3.0.2 specification](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md))
>    * Message/Event-Based API (use [AsyncAPI 1.2.0 specification](https://www.asyncapi.com/docs/specifications/1.2.0/))
>    * REST API (use [OpenAPI 3.0.2 specification](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md))
>    * SOAP API (use [WSDL 2.0 specification](https://www.w3.org/TR/wsdl20/))
> * `agreement` is the URI to the local file or the Confluence page that describes the Interface Agreement of each available interface
> 
> Below you can find the skeleton of the table to fill in.

<table>
  <tr>
    <th>Interface Type</th>
    <th>Interface Agreement</th>
  </tr>
  <tr>
    <td>Command-Line Interface (CLI)</th> 
    <td>path/to/repo/file</td>
  </tr>
  <tr>
    <td>REST API</th> 
    <td>https://sdp.finconsgroup.com/confluence/specs/my-project-api</td>
  </tr>
</table>

## Repository layout

> Describe:
> * layout of files and folders in the repository
>     * it is worthwhile to mention any command you run to create the skeleton (e.g. `npx express-generator` or `npx create-react-app`)
> * content and purpose for all folders and files at the top level of the repository and for any other folders and files required to build, run and deploy the code in the repository
> 
> Add the pieces of information above to the following list.

 * .gitlab/merge_request_templates - list of templates to use when you submit a merge request. See [Using the templates](https://sdp-gitlab.finconsgroup.com/help/user/project/description_templates.md#using-the-templates) for details on how to select the template when you submit a merge request.
    * [master](.gitlab/merge_request_templates/master.md) template to fill in when you submit a merge request with target branch `master`
 * [BUILDME.md](BUILDME.md) - detailed instructions on
    * how to run unit tests and static analysis
    * how to create a deployable package for the code in this repository
 * [COPYRIGHT](COPYRIGHT) - copyright notice
 * [DEPLOYME.md](DEPLOYME.md) - detailed instructions on
    * how to run locally the code in this repository or the package built by following the instructions in BUILDME.md
    * how to run the code
 * [LICENSE](LICENSE) - licensing terms
 * [README.md](README.md) - this file

## Git Etiquette

Git Etiquette defines the branching workflow that applies to this repository: it is available on [Confluence](https://sdp.finconsgroup.com/confluence/display/SDP/Git+Etiquette+and+Branching+Workflow).