Skip to content

Latest commit

 

History

History
56 lines (31 loc) · 2.38 KB

starting-testing-the-app.md

File metadata and controls

56 lines (31 loc) · 2.38 KB
Raw

Starting and testing the application

Preparing the application for the first time

Prerequisites

Steps

  1. Follow the steps for 'Getting started' on the register-a-food-business-environment repository.
  2. Change directory to this repository (register-a-food-business-service)
  3. Run npm install
  4. Populate a .env file. The contents of this file must be handed over from existing developers.

Starting the application

  • npm start starts the localhost server.

Steps:

  1. Run npm start
  2. Send requests to http://localhost:4000 from Postman to test the application

Testing the application

The /package.json file contains a number of scripts that are used in the Azure devOps pipelines to test the code in this repository. These scripts can also be run locally to prevent unnecessary pipeline builds, using the following commands:

  • npm test

    Runs all of the unit tests and provides a coverage report.

  • npm run test:watch

    Runs all of the unit tests once, then watches for changes to any relevant files and re-runs just those tests.

  • npm run test:integration

    Runs all of the integration tests between the connectors and local doubles of external services. For more information about integration tests, see https://martinfowler.com/bliki/IntegrationTest.html.

  • npm run test:contract

    Runs all of the contract tests between the external services and their local doubles. For more information about contract tests, see https://martinfowler.com/bliki/ContractTest.html.

  • npm run test:security

    Runs the Snyk vulnerability test tool with a "medium" severity threshold. For more information about Snyk, see https://snyk.io.

  • npm run lint

    Runs the ESLint tool against the repository. For more information about ESLint, see https://eslint.org/.

  • npm run format:verify

    Runs the Prettier code-formatting tool against the repository. For more information about Prettier, see https://prettier.io/. Formatting issues can often be corrected by running npm format. It is recommended to install the Prettier code-formatting extension for your chosen IDE, and to enable automatic Prettier formatting on every 'save' if possible.