Skip to content

Commit

Permalink
Merge pull request #452 from NYPL/SFR-1760_update_readme_epubtowebpub
Browse files Browse the repository at this point in the history
SFR-1760: Update README C4 Diagram and EPUB to webpub context
  • Loading branch information
jackiequach authored Oct 24, 2023
2 parents a21f2e2 + 9c991c2 commit 314c191
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

1 comment on commit 314c191

@vercel
Copy link

@vercel vercel bot commented on 314c191 Oct 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.