diff --git a/CHANGELOG.md b/CHANGELOG.md index b66f43ab..a419169f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ - Replace fireEvent with userEvent - Feedback button test PW - SFR-1797: Remove Playwright tests with clicks on header and footer links +- Update README with C4 diagrams and epub-to-webpub info ## [0.17.4] diff --git a/README.md b/README.md index 4d3ce077..2f423053 100644 --- a/README.md +++ b/README.md @@ -70,10 +70,18 @@ Term combinations - Webpub reader: DRB serves an epub through the [webpub-viewer](https://github.com/NYPL-Simplified/webpub-viewer/tree/SFR-develop). DRB commonly does this for Gutenberg Project books. - Download: DRB offers a link to download the book online. This is often done for PDFs. +### EPUB to Webpub + +The EPUB to Webpub Next.js app is deployed at `https://epub-to-webpub.vercel.app`. The **`/api/[containerXmlUrl]`** endpoint is used by the DRB backend to convert `container.xml` files of exploded EPUBs to webpub manifests. + ### Test To run unit tests, run `npm run test` in the terminal. +### C4 Architecture Diagrams + +Diagrams for DRB can found via our public [Structurizr link](https://structurizr.com/share/72104) and can be updated in the (c4-diagrams repo)[https://github.com/NYPL-Simplified/c4-diagrams]. + ### Deprecated As of September 2023, the [rspec-integration-tests.yml](https://github.com/NYPL/sfr-bookfinder-front-end/actions/workflows/rspec-integration-tests.yml) workflow is no longer in use and has been replaced by the [Playwright.yml](https://github.com/NYPL/sfr-bookfinder-front-end/blob/development/.github/workflows/Playwright.yml) workflow. Please contact the DRB team in Digital for more information.