From 2ebd91fe3c4f8787d497187d778eb235cc92054c Mon Sep 17 00:00:00 2001 From: Steve McConnel Date: Thu, 21 Nov 2024 15:19:20 -0700 Subject: [PATCH] chore: Update README.md for vite and unit tests (20241121) --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21400b95..6fc6eb88 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ Run `yarn` to get the dependencies. Either, run `yarn storybook` (which has multiple books), -or run `yarn start` (which will use `index-for-developing.html`). +or run `yarn dev` (which will use `index-for-developing.html`). Note: you need to have `chrome` on your path. @@ -111,7 +111,7 @@ See package.json for other scripts. Depending on what book you are loading, if the book is on bloomlibrary.org or dev.bloomlibrary.org, CORS headers there will normally prevent your local bloom-player from loading the book, because it is not in the right domain. To get around this, you need to run your browser in a special low-security mode. -Both `yarn storybook` and `yarn start` do this for you. +Both `yarn storybook` and `yarn dev` do this for you. ### Testing with a book hosted by Bloom @@ -121,6 +121,10 @@ Note that while testing, one option is to run Bloom, select your book, go to the For more information, see README-advanced.md +### Running unit tests + +Unit tests have been written for some code which processes inputs to produce output. These tests are run by `yarn test`. Test files are indicated by the suffix `.test.ts`. They generally exist in the same folder as the files containing the code being tested. + ## License MIT