Stand-alone viewer section

This commit is contained in:
dannyrb 2019-04-28 13:44:51 -04:00
parent 1ae6704ed0
commit fcd2d63c5b

View File

@ -2,16 +2,17 @@
The OHIF Viewer can be embedded in other web applications via it's [packaged The OHIF Viewer can be embedded in other web applications via it's [packaged
script source][ohif-viewer-npm], or served up as a stand-alone PWA ([progressive script source][ohif-viewer-npm], or served up as a stand-alone PWA ([progressive
web application][pwa-url] by building and hosting a collection of static assets. web application][pwa-url]) by building and hosting a collection of static
In either case, you will need to configure your instance of the Viewer so that assets. In either case, you will need to configure your instance of the Viewer
it can connect to your data source (the database or PACS that provides the data so that it can connect to your data source (the database or PACS that provides
your Viewer will display). Let's unpack that a little: the data your Viewer will display).
## Overview ## Overview
Our goal is to make deployment as simple and painless as possible; however, Our goal is to make deployment as simple and painless as possible; however,
there is an inherent amount of complexity in customizing, optimizing, and there is an inherent amount of complexity in customizing, optimizing, and
deploying web applications. If deploying web applications. If you find yourself a little lost, please don't
hesitate to [reach out for help](/help.md)
## Deployment Scenarios ## Deployment Scenarios
@ -22,7 +23,7 @@ it into an existing web application. It allows us to forego a "build step", and
add a powerful medical imaging viewer to an existing web page using only a few add a powerful medical imaging viewer to an existing web page using only a few
include tags. include tags.
- Read more about it here: [Embedded Viewer](/deployment/embedded-viewer.html) - Read more about it here: [Embedded Viewer](./recipes/embedded-viewer.md)
- And check out our - And check out our
[live demo on CodeSandbox](https://codesandbox.io/s/lrjoo3znxm) [live demo on CodeSandbox](https://codesandbox.io/s/lrjoo3znxm)
@ -31,7 +32,19 @@ include tags.
### Stand-alone Viewer ### Stand-alone Viewer
Deploying the OHIF Viewer as a stand-alone web application provides many Deploying the OHIF Viewer as a stand-alone web application provides many
benefits, but comes at the cost of time and complexity. benefits, but comes at the cost of time and complexity. Some benefits include:
_Today:_
- Leverage [extensions](/advanced/extensions.md) to drop-in powerful new
features
- Add routes and customize the viewer's workflow
- Finer control over styling and whitelabeling
_In the future:_
- The ability to package the viewer for [App Store distribution][app-store]
- Leverage `service-workers` for offline support and speed benefits from caching
#### Hosted Static Assets #### Hosted Static Assets
@ -41,9 +54,7 @@ benefits, but comes at the cost of time and complexity.
... ...
## Gotchas ## Data
## Next Steps
### Securing your data ### Securing your data
@ -51,10 +62,11 @@ benefits, but comes at the cost of time and complexity.
Links Links
--> -->
<!-- prettier-ignore-start -->
[ohif-viewer-npm]: https://www.npmjs.com/package/ohif-viewer [ohif-viewer-npm]: https://www.npmjs.com/package/ohif-viewer
[pwa-url]: https://developers.google.com/web/progressive-web-apps/ [pwa-url]: https://developers.google.com/web/progressive-web-apps/
[static-assets-url]: https://www.maxcdn.com/one/visual-glossary/static-content/ [static-assets-url]: https://www.maxcdn.com/one/visual-glossary/static-content/
[app-store]: https://medium.freecodecamp.org/i-built-a-pwa-and-published-it-in-3-app-stores-heres-what-i-learned-7cb3f56daf9b
``` <!-- prettier-ignore-end -->
```