PIRAT Frontend

This repository contains the frontend web application for https://pirat-tool.com/.

Setup

Prerequisites

A running backend server is required for the web app to work. More details about how to start the backend can be found in the backend repository.

Furthermore, the following tools should be installed:

• nodejs
• Angular CLI (npm install -g @angular/cli)

Getting Started

This is an Angular app.

To start the development mode:

npm run start

Linting (please run it before every commit):

npm run lint

We use Angular's i18n. The translation files are in a separate repository which is included as a Git submodule into this repository (-> src/i18n). Run the following command to extract the i18n-marked strings in the HTMLs:

npm run extract-i18n

Afterwards, commit the changes in the i18n repository.

Translations

Contributing

We follow a slightly trimmed-down version of the Gitflow Workflow [1, 2]. We have four type of branches:

• master - Deployed on the production page
• develop - Deployed on the internal test page
• feature-branches - They start with feature/
• hotfix-branches - They start with hotfix/

[1] https://nvie.com/posts/a-successful-git-branching-model/
[2] https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow