Architecture

This document describes the architecture of the project.

`.github/workflows`

Here you can create and store yml files for each github action.

`check-semantic-prs.yml`

Github action to check if the PR title is following the semantic commit message.

`ci.yml`

Github action to run the test and build the project.

`deploy-docs.yml`

Github action to deploy the documentation to the gh-pages branch.

`.husky`

Husky is a tool to prevent bad git commit, git push, and more. See the husky doc for more.

`docs`

Folder where we keep all our documentation files.

`.vuepress`

Folder where we keep all our vuepress configuration files. See the vuepress doc for more.

`.storybook`

Folder where we keep all our storybooks

`cypress`

Folder where we keep all our e2e test files.

`src`

Where we keep all our source files.

`app`

Core folder for our application

`assets`

Asset folder where we keep all our static assets

`i18n`

Asset folder where we keep all our translations and internalization

`environments`

Folder where we keep our different environments

`.gitignore`

Here you can store the files and folders that you want to ignore in the git repository.

`.prettierrc`

Prettier configuration file, see the prettier doc for more.

`commitlint.config.mjs`

Commitlint configuration file, see the commitlint doc for more.

`docker-compose.yml`

Docker compose configuration file for development, see the docker docs for more.

`docker-compose.local.yml`

Docker compose configuration file for local development.

`Dockerfile`

The basic Dockerfile configuration to build the app, see the docker docs for more.

`eslint.config.mjs`

Eslint configuration file, see the eslint doc & typescript-eslint for more.

`jest.config.json`

Jest configuration file, see the jest doc for more.

`lint-staged.config.mjs`

The configuration of the lint-staged, see the lint-staged doc for more.

`angular.json`

Angular configuration file, see the angular doc for more.

`package.json`

Here you can store the configuration of the project.

`pnpm-lock.yaml`

pnpm lock file generated by pnpm.

`README.md`

Here you can store the description of the project.

`renovate.json`

Renovate configuration file, see the renovate doc for more.

`setup-jest.mjs`

Setup file for jest.

`tsconfig.app.json`

Here you can store the typescript configuration of the project for the app.

`tsconfig.json`

Here you can store the typescript configuration of the project.

`tsconfig.spec.json`

Here you can store the typescript configuration of the project for tests.

`transloco.config.js`

Here you can store the configration for transloco for localization

`cypress.config.ts`

Here you can modify configuration for the cypress e2e tests

`codecov.yml`

Here you can modify configuration for the codecov