Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
iamfrank committed Nov 9, 2023
1 parent efb9801 commit a832391
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/
Expand All @@ -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
17 changes: 17 additions & 0 deletions docs/tutorials/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

0 comments on commit a832391

Please sign in to comment.