From 5140ad71839d1e6ab7b06dc0eb5bc382ca4e2c4d Mon Sep 17 00:00:00 2001 From: Jackie Quach Date: Tue, 24 Oct 2023 13:19:26 -0400 Subject: [PATCH] update readme --- CHANGELOG.md | 1 + README.md | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f23454c4..12a7817b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ - Upgrade to NYPL Design System 1.7.3 - Replace fireEvent with userEvent - Feedback button test PW +- 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.