Time-Tracker-UI

This project was generated using Angular CLI version 9.0.4.

Metrics

Code Coverage Status

CD Pipeline Status

Prerequisites

Node.js

Install Node.js from [https://nodejs.org/en/download/] but we recommend that you install it using Node Version Management [https://github.com/nvm-sh/nvm] (v12.16.1 LTS).

Angular CLI

Angular CLI is a Command Line Interface (CLI) to speed up your development with Angular.

Run npm install -g @angular/cli to install Angular CLI

Install Node Modules

Run npm install to install the required node_modules for this project.

Development server

Run ng serve to run the app in dev mode. After executing this command, you can navigate to http://localhost:4200/ to see the app working. The app will automatically reload if you change anything in the source files.

Prepare your environment

Set environment variables

Create a file keys.ts with the content pinned in our slack channel:

export const AUTHORITY = 'XXX';
export const CLIENT_ID = 'XXX';
export const SCOPES = ['XXX'];
export const STACK_EXCHANGE_ID = 'XXX';
export const STACK_EXCHANGE_ACCESS_TOKEN = 'XXX';

Prepare your environment for vscode

Install the following extensions:

• EditorConfig for Visual Studio Code.
• TSLint
• Prettier - Code formatter.
• Go to user settings (settings.json) and enable formatting on save: "editor.formatOnSave": true.

Commit message format

A commit message needs to start with one of the following words to bump the application version properly (This application is following a semver strategy for versioning https://semver.org/)

Sumary

• fix is equal to Patch Release example: 1.0.1
• feat is equal to Feature Release example: 1.1.0
• perf is equal to Breaking Release example: 2.0.0

Example

fix: #48 implement semantic version.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running mutation tests

Mutation tests have been enabled using stryker. You can run those tests locally, it takes ~4 hours to have the results. If you want to run them locally please install stryker locally:

npm install -g stryker-cli

Now, run stryker:

stryker run

Stryker is also executed on GitHub actions with the following cron expresion:

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Deploy the app on Azure

The app deployment is automatically executed after each pull request is merged in master. That's wht it is necessary that each pull request meets at least 80% of test coverage.

You can visit the app in the following link:

Time-Tracker

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.