@tul/stadistic v1.0.0

TUL - Stadistic

Table of Contents

• 1 Application Links
• 2 About The Project
  • 2.1 Built With
• 3 Getting Started
  • 3.1 Prerequisites
  • 3.2 Installation
• 4 Usage
  • 4.1 Commands
• 5 GIT
  • 5.1 Branches
  • 5.2 Branching workflow
• 6 Arquitecture
  • 6.1 Angular Arquitecture
• 7 TODO List

1 Application Links

• Production (to define)
• UAT (to define)

2 About The Project

The name of the project is a "TUL Statistics" this allows to build from a JSON cards with different statistics and values, using NG-ZORRO as a base. with this you can set number of columns, horizontal space, vertical space and which is the source that will supply you the data.

2.1 Built With

1. Angular CLI version 11.0.7

3 Getting Started

To run the library locally, follow these simple example steps.

3.1 Prerequisites

1. Node.js v14.19.0
2. npm - v6.14.16
3. Angular CLI version 11.0.7
4. Python version 2.7

You need to install npm first and then angular cli with the following commands. We also recommend using Visual Studio Code as IDE.

3.2 Installation

1 Clone the repo

git clone https://gdavidvargas@bitbucket.org/Soytul/stadistic.git

2 Install NPM packages

npm install

3 Build the App

npm run build

4 Pack the Library

npm run pack

5 Get URL for local tests

• In your project install the generated .tgz file in

 .\stadistic\dist\tul-stadistic\tul-stadistic-1.0.XX.tgz

6 Install in your App

npm i C:\Users\...\stadistic\dist\tul-stadistic\tul-stadistic-1.0.xx.tgz

6 HTML

<lib-tul--stadistic></lib-tul--stadistic>

4 Usage

The following commands and instructions will help you know how to deploy or run functionalities locally.

4.1 Commands

This commands are in the scripts of package.json.

npm run build           # Run the compiler
npm run build --prod    # Run the compiler for production
npm run pack            # Generate the pack

5 Git

In this section we will explain our git strategy.

5.1 Branches

• master: Current version in prod, each merge on this branch should be tag and deployed.
  • hotfixes: Start from master, fix a problem who can not wait for the next release. Should be merge on master AND dev.
• develop: Next prod release, should be merge on master when version is ready.
  • features: Start from dev, this a work in progress feature, should be merged on dev

5.2 Branching Workflows

1. Create a feature branch from dev
2. Create your Feature Branch (git checkout -b feature/PL-###)
3. Commit your Changes (It's recommended to use git cz)
4. Push to the Branch (git push origin feature/PL-###)
5. Open a Pull Request
6. After validation, merge your pull request on dev

6 Arquitecture

6.1 Angular Architecture

The project use a multimodule design pattern.

src/
|
|– lib/
|   |   |-components/          # Components files
|   |   |-enums/               # Enums files
|   |   |-interface/           # interface files

7 TODO List

• Finish the README.md