Skip to content

Commit

Permalink
fix package-lock.json
Browse files Browse the repository at this point in the history
  • Loading branch information
jbilcke-hf committed Jul 30, 2024
1 parent 58cb97c commit 029a7e3
Show file tree
Hide file tree
Showing 2 changed files with 4,746 additions and 6,878 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,9 @@ npm run dev

`--include=optional` is to make sure optional dependencies are installed (pre-build native modules compatible with your system)

### Making sure everything is working properly
### Building the app

There are no tests yet (I will create a ticket for that),
but until then you can run the following command to make sure all the types are consistant and properly set:
You can run the following command to build the app, making sure all the types are consistant and properly set:

```bash
npm run build
Expand Down Expand Up @@ -125,21 +124,21 @@ You might see a DeprecationWarning message written in red at the end but that's

### Code conventions

I haven't setup Prettier or a Linter yet.
I have setup Prettier and ESLint, they use some basic rules (you can propose new rules if you want to)

### Testing

@jbilcke-hf is working to add tests, and will also act as the "QA engineer".

To run all the tests (unit and e2e) please run:

`npm test`

This is not instantaneous: playwright may seems to do nothing for a while at first.

@jbilcke-hf is working to add more tests, and will also act as the "QA engineer".

#### Unit tests

Note: I've just added Vitest so we only have like 2 tests for now.
Note: I've just added Vitest so we only have a few tests for now.


To run the test without watching, type:
Expand Down
Loading

0 comments on commit 029a7e3

Please sign in to comment.