Skip to content

Commit

Permalink
docs: document how to run the tests
Browse files Browse the repository at this point in the history
  • Loading branch information
joanise authored and roedoejet committed Oct 26, 2023
1 parent b88ac24 commit d869ee7
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,15 @@ $ npm install

Then, you can create a new repo on GitHub and reset the origin remote to your new repo:

`git remote set-url origin https://github.com/<yourusername>/<yourrepo>`
```sh
git remote set-url origin https://github.com/<yourusername>/<yourrepo>
```

Then, add a new repo and set the url to this:

`git remote add ww https://github.com/roedoejet/wordweaver.git`
```sh
git remote add ww https://github.com/roedoejet/wordweaver.git
```

That way, you can make changes in your repo, push them to your origin, but still pull new changes to the gui using `git pull ww main`

Expand Down Expand Up @@ -81,6 +85,27 @@ Feel free to dive in! [Open an issue](https://github.com/roedoejet/wordweaver/is

This repo follows the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) Code of Conduct.

### Running the test suites

To execute the unit test suites, run:

```
npm run-script test # regular mode
npm run-script ci:test # alternative, headless mode
```

To execute the end-to-end test suite, you must first install Playwright by running:

```
npx playwright install --with-deps
```

and then you can execute the suite with:

```
npm run-script e2e
```

### Contributors

This project exists thanks to all the people who contribute.
Expand Down

0 comments on commit d869ee7

Please sign in to comment.