43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
# Installation
|
|
|
|
It's important to know that the OHIF Viewer project provides two different build
|
|
processes:
|
|
|
|
```bash
|
|
# Static Asset output: For deploying PWAs
|
|
yarn run build:web
|
|
|
|
# Single `.js` script, for embedding viewer into existing apps
|
|
yarn run build:package
|
|
```
|
|
|
|
## create-react-app (PWA)
|
|
|
|
> [create-react-app](https://github.com/facebook/create-react-app) provides
|
|
> pre-configured build process for developing front-end applications with
|
|
> [React](https://reactjs.org/).
|
|
|
|
The ohif-viewer package can be run as a create-react-app application. This is
|
|
useful for development, debugging, or evolving the OHIF Viewer into your own
|
|
custom imaging application.
|
|
|
|
You can read more about this particular strategy in our
|
|
[Build for Production Deployment Guide](./../deployment/recipes/build-for-production.md)
|
|
|
|
## Rollup (Packaged Script)
|
|
|
|
> [Rollup](https://rollupjs.org/guide/en) is a module bundler for JavaScript. It
|
|
> uses the new standardized format for code modules included in the ES6 revision
|
|
> of JavaScript.
|
|
|
|
The [ohif-viewer](https://www.npmjs.com/package/ohif-viewer) package can be
|
|
built with Rollup to provide a set of React components which can be dropped into
|
|
a larger application. Specifically, the ohif-viewer package provides a React
|
|
component named `OHIFViewer` which is the entire viewer, configurable via React
|
|
`props`. This is useful for including the OHIF Viewer in a larger web
|
|
application, as the entire application can be provided via a `<script>` tag with
|
|
no build process required.
|
|
|
|
You can read more about this particular strategy in our
|
|
[Embedded Viewer Deployment Guide](./../deployment/recipes/embedded-viewer.md)
|