Skip to content

Commit

Permalink
Merge pull request #342 from StephenMcConnel/UpdateReadmeForUnitTests…
Browse files Browse the repository at this point in the history
…-20241121

chore: Update README.md for vite and unit tests (20241121)
  • Loading branch information
andrew-polk authored Nov 21, 2024
2 parents 135b34b + 2ebd91f commit dda50da
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand All @@ -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

0 comments on commit dda50da

Please sign in to comment.