Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.51 KB

README.md

File metadata and controls

62 lines (42 loc) · 1.51 KB
Raw

OKR-Tool Frontend

This is the Angular Frontend for the OKR-Tool.

DEVELOPING

Environment:

  • We require Node.js ^18

Install:

  • Install npm dependencies: npm install
  • Make a clean install: npm ci
  • Install the git hooks for the frontend: npm run prestart

Formatting:

  • Check code formatting: npm run check
  • Format the code: npm run format

Test and Run:

  • Execute the tests: npm run test
  • Start the frontend: npm run start

Build:

  • Build for production: npm run build

Formatting

We use EsLint and a variety of plugins to format html and ts files: https://eslint.org/

We use prettier to format scss json and yaml files: https://prettier.io/

Test Coverage

For generating the coverage of our frontend specs (jest), you can use following command: npx jest --coverage (jest --coverage if you have jest installed locally)

This generates the coverage, you can see it in frontend/coverage/lcov-report/index.html. Open the html file in browser and you get a beautiful overview

Cypress Tests

  • local setup
    • start local Docker docker-compose up
    • start local Server: OkrApplication-E2E
    • start local Client: npm run start
  • run selected Tests
    • npm run npm run cypress:open
    • in Cypress App, select E2E Testing and Chrome as Browser
  • run all tests
    • npm run npm run cypress:run
    • in Cypress App, select E2E Testing and Chrome as Browser
  • in case of failing Tests:
    • stop and restart local Server
    • stop and restart local Client
    • re-run Cypress Tests