From a832391bb5360cf3472929e9841a3e17bb297302 Mon Sep 17 00:00:00 2001 From: Frank Thomsen Date: Thu, 9 Nov 2023 10:48:13 +0100 Subject: [PATCH] update docs --- README.md | 6 ++++-- docs/tutorials/installing.md | 17 +++++++++++++++++ 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9418b54a..d85f3d00 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # skraafoto_frontend -`skraafoto_frontend` **(Skraafoto)** is an application that lets users browse **skewed arial photographs (skråfotos)** in a web browser. +`skraafoto_frontend` **(Skraafoto)** is an application that lets users browse **oblique arial photographs (skråfotos)** in a web browser. Photographs are fetched using [Skråfoto STAC API](https://github.com/SDFIdk/skraafoto_stac_public/blob/main/dokumentation.md). The full documentation is available at https://sdfidk.github.io/skraafoto_frontend/ @@ -9,4 +9,6 @@ The full documentation is available at https://sdfidk.github.io/skraafoto_fronte - [Instructions for installation](https://sdfidk.github.io/skraafoto_frontend/tutorial-installing.html) - [System overview](https://sdfidk.github.io/skraafoto_frontend/tutorial-overview.html) -Provided by *Styrelsen for Dataforsyning og Infrastruktur* 2022 +For information on running local servers and testing, see [Instructions for installation](https://sdfidk.github.io/skraafoto_frontend/tutorial-installing.html) + +Provided by *Styrelsen for Dataforsyning og Infrastruktur* 2023 diff --git a/docs/tutorials/installing.md b/docs/tutorials/installing.md index 14e743a6..51a02196 100644 --- a/docs/tutorials/installing.md +++ b/docs/tutorials/installing.md @@ -39,3 +39,20 @@ Run `npm run dev` to start a development server running locally at `localhost:80 ## Build for production Run `npm run build` to make a production build. The built resources are saved in `dist/` folder; ready to be hosted along with the static assets in the `public` folder. + +## Run tests + +### Playwright E2E tests +You'll need to install Playwright dependencies **once** before running the E2E tests. +Do so with `npx playwright install --with-deps` + +Then make sure you have a local development server running. +Run `npm run dev` for this. + +Now you can run the test using: +`npm run test` + +The Playwright test suite will present you with a HTML report if some tests fail. + +### Unit tests +Unit tests are run with `npm run test-unit`