Skip to content

Commit

Permalink
improve elm/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Perone committed Jun 14, 2022
1 parent b81b321 commit d710ffb
Showing 1 changed file with 5 additions and 31 deletions.
36 changes: 5 additions & 31 deletions elm/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tagger Elm client

This folder contains a client application built with [Elm](https://elm-lang.org/), which allows to interact in a human-friendly way with the Tagger api.
This folder contains a client application built with [Elm](https://elm-lang.org/), which allows interacting in a human-friendly way with the Tagger API.

## Build

Expand All @@ -14,9 +14,9 @@ Then, you can directly open `index.html` to interact with the application.

## Workflow

The application requires you to first register a new user. Once this is done, you can login with the same credentials and access the private area.
The application requires you to first register a new user. Once this is done, you can log in with the same credentials and access the private area.

In the private area, you'll see the contents for the logged in user and you can also:
In the private area, you'll see the contents for the logged-in user, and you can also:

- add new contents with their tags;
- filter the shown contents by tag.
Expand All @@ -25,32 +25,6 @@ In the private area, you'll see the contents for the logged in user and you can

The `spec` folder contains some end-to-end acceptance tests written using [Quickstrom](https://quickstrom.io/).

To run them, you could execute the following commands inside the `spec` folder, given your application is exposed on `localhost:8000`:
To run them, just execute `bin/test/quickstrom` from the root of the project, given your application is exposed on `localhost:8000`.

```
docker run --rm -d \
--name webdriver \
--network=host \
-v /dev/shm:/dev/shm \
-v $PWD:/spec \
selenium/standalone-chrome:3.141.59-20200826
docker run --rm \
--network=host \
-v $PWD:/spec \
quickstrom/quickstrom \
quickstrom check \
--webdriver-host=webdriver \
--webdriver-path=/wd/hub \
--browser=chrome \
--reporter=html \
--html-report-directory=/spec/report \
--tests=10 \
--max-actions=50 \
--max-trailing-state-changes=1 \
--trailing-state-change-timeout=500 \
/spec/Tagger.spec.purs \
http://localhost:8000
```

Then in the `spec/report` folder you'll find an `index.html` file containing a report of each test which was executed.
Then in the `elm/spec/report` folder you'll find an `index.html` file containing a report of each test which was executed.

0 comments on commit d710ffb

Please sign in to comment.