diff --git a/.netlify/build-deploy-preview.sh b/.netlify/build-deploy-preview.sh index cbb51c376..b088f9d46 100644 --- a/.netlify/build-deploy-preview.sh +++ b/.netlify/build-deploy-preview.sh @@ -27,4 +27,4 @@ mv platform/viewer/dist/* .netlify/www/pwa -v echo 'Nothing left to see here. Go home, folks.' # Build using react-scripts -# npx cross-env PUBLIC_URL=/demo REACT_APP_CONFIG=config/netlify.js react-scripts --max_old_space_size=4096 build +# npx cross-env PUBLIC_URL=/demo APP_CONFIG=config/netlify.js react-scripts --max_old_space_size=4096 build diff --git a/docs/latest/advanced/_maintained-extensions-table.md b/docs/latest/advanced/_maintained-extensions-table.md index 41c0c60f7..43a558e46 100644 --- a/docs/latest/advanced/_maintained-extensions-table.md +++ b/docs/latest/advanced/_maintained-extensions-table.md @@ -10,7 +10,7 @@ - + Cornerstone @@ -22,7 +22,7 @@ - + VTK.js @@ -33,30 +33,30 @@ - HTML + DICOM HTML - Renders text and HTML content for specific SopClassUIDs. + Renders text and HTML content for specific SopClassUIDs. Viewport, SopClassHandler - PDF + DICOM PDF - Renders PDFs for a specific SopClassUID. + Renders PDFs for a specific SopClassUID. Viewport, SopClassHandler - Microscopy + DICOM Microscopy - Renders Microscopy images for a specific SopClassUID. + Renders Microscopy images for a specific SopClassUID. Viewport, SopClassHandler - \ No newline at end of file + diff --git a/docs/latest/advanced/extensions.md b/docs/latest/advanced/extensions.md index 4953eb80d..b2c8b71a6 100644 --- a/docs/latest/advanced/extensions.md +++ b/docs/latest/advanced/extensions.md @@ -152,7 +152,7 @@ is used depends on:
An example of three Viewports
For a complete example implementation, -[check out the OHIFCornerstoneViewport](https://github.com/OHIF/Viewers/blob/react/extensions/ohif-cornerstone-extension/src/OHIFCornerstoneViewport.js). +[check out the OHIFCornerstoneViewport](https://github.com/OHIF/Viewers/blob/master/extensions/cornerstone/src/OHIFCornerstoneViewport.js). #### Toolbar @@ -168,7 +168,7 @@ store. Toolbar components are rendered in the `ToolbarRow` component. For a complete example implementation, -[check out the OHIFCornerstoneViewport's Toolbar Module](https://github.com/OHIF/Viewers/blob/react/extensions/ohif-cornerstone-extension/src/ToolbarModule.js). +[check out the OHIFCornerstoneViewport's Toolbar Module](https://github.com/OHIF/Viewers/blob/master/extensions/cornerstone/src/toolbarModule.js). #### SopClassHandler @@ -197,9 +197,9 @@ would like included at startup. _app.js_ ```js -import { createStore, combineReducers } from "redux"; -import OHIF from "@ohif/core"; -import OHIFCornerstoneExtension from "ohif-cornerstone-extension"; +import { createStore, combineReducers } from 'redux'; +import OHIF from '@ohif/core'; +import OHIFCornerstoneExtension from 'ohif-cornerstone-extension'; const combined = combineReducers(OHIF.redux.reducers); const store = createStore(combined); @@ -214,8 +214,8 @@ ExtensionManager.registerExtensions(store, extensions); A small number of powerful extensions for popular use cases are maintained by OHIF. They're co-located in the -[`OHIF/Viewers`](https://github.com/OHIF/Viewers/tree/react/) repository, in the -top level [`extensions/`](https://github.com/OHIF/Viewers/tree/react/extensions) +[`OHIF/Viewers`](https://github.com/OHIF/Viewers) repository, in the top level +[`extensions/`](https://github.com/OHIF/Viewers/tree/master/extensions) directory. {% include "./_maintained-extensions-table.md" %} @@ -225,6 +225,6 @@ directory. --> -[example-ext-src]: https://github.com/OHIF/Viewers/blob/master/extensions/_ohif-example-extension/src/index.js) -[module-types]: https://github.com/OHIF/ohif-core/blob/43c08a29eff3fb646a0e83a03a236ddd84f4a6e8/src/plugins.js#L1-L6 +[example-ext-src]: https://github.com/OHIF/Viewers/tree/master/extensions/_example/src +[module-types]: https://github.com/OHIF/Viewers/blob/master/platform/core/src/extensions/MODULE_TYPES.js diff --git a/docs/latest/connecting-to-image-archives/google-cloud-healthcare.md b/docs/latest/connecting-to-image-archives/google-cloud-healthcare.md index 6521dae49..dc36b8e1d 100644 --- a/docs/latest/connecting-to-image-archives/google-cloud-healthcare.md +++ b/docs/latest/connecting-to-image-archives/google-cloud-healthcare.md @@ -53,7 +53,7 @@ Images can even be transcoded on the fly if this is desired. ```bash cd OHIFViewer yarn install -REACT_APP_CONFIG=config/google.js yarn run dev +APP_CONFIG=config/google.js yarn run dev ``` ## Running via Docker diff --git a/docs/latest/deployment/recipes/build-for-production.md b/docs/latest/deployment/recipes/build-for-production.md index 3265c158d..1b9c43b94 100644 --- a/docs/latest/deployment/recipes/build-for-production.md +++ b/docs/latest/deployment/recipes/build-for-production.md @@ -71,11 +71,11 @@ how to configure the project for your own imaging archive below. #### How it Works The configuration for our project is in the `/public/config` directory. Our -build process knows which configuration file to use based on the -`REACT_APP_CONFIG` environment variable. By default, its value is -[`default.js`](https://github.com/OHIF/Viewers/blob/react/public/config/default.js). -When we build, the `%REACT_APP_CONFIG%` value in -our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/react/public/index.html#L12-L15) +build process knows which configuration file to use based on the `APP_CONFIG` +environment variable. By default, its value is +[`default.js`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/config/default.js). +When we build, the `%APP_CONFIG%` value in +our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/index.html) file is substituted for the correct configuration file's name. This sets the`window.config` equal to our configuration file's value. @@ -104,17 +104,17 @@ window.config = { }, ], }, -} +}; ``` You can also create a new config file and specify its path relative to the build -output's root by setting the `REACT_APP_CONFIG` environment variable. You can -set the value of this environment variable a few different ways: +output's root by setting the `APP_CONFIG` environment variable. You can set the +value of this environment variable a few different ways: - [Add a temporary environment variable in your shell](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell) - [Add environment specific variables in `.env` file(s)](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-development-environment-variables-in-env) - Using the `cross-env` package in an npm script: - - `"build": "cross-env REACT_APP_CONFIG=config/my-config.js react-scripts build"` + - `"build": "cross-env APP_CONFIG=config/my-config.js react-scripts build"` After updating the configuration, `yarn run build:web` to generate updated build output. diff --git a/docs/latest/deployment/recipes/nginx--image-archive.md b/docs/latest/deployment/recipes/nginx--image-archive.md index 6a3da8b0a..baaf64ae4 100644 --- a/docs/latest/deployment/recipes/nginx--image-archive.md +++ b/docs/latest/deployment/recipes/nginx--image-archive.md @@ -11,7 +11,7 @@ control. Do not use this recipe to host sensitive medical data on the open web. Depending on your company's policies, this may be an appropriate setup on an internal network when protected with a server's basic authentication. For a more robust -setup, check out our [user account control recpie](./user-account-control.md) +setup, check out our [user account control recipe](./user-account-control.md) that builds on the lessons learned here. ## Overview @@ -51,7 +51,7 @@ We can solve this one of two ways: This solution uses the first approach, but you can see an example of the second in the `docker-compose` bundled with this project for local development: -[HERE](#) +[HERE](https://github.com/OHIF/Viewers/blob/master/platform/viewer/.recipes/Nginx-Orthanc/docker-compose.yml) You can read more about CORS in this Medium article: [Understanding CORS][understanding-cors] @@ -124,10 +124,10 @@ likely want to update: The OHIF Viewer's configuration is imported from a static `.js` file and made available globally at `window.config`. The configuration we use is set to a specific file when we build the viewer, and determined by the env variable: -`REACT_APP_CONFIG`. You can see where we set its value in the `dockerfile` for -this solution: +`APP_CONFIG`. You can see where we set its value in the `dockerfile` for this +solution: -`ENV REACT_APP_CONFIG=config/docker_openresty-orthanc.js` +`ENV APP_CONFIG=config/docker_openresty-orthanc.js` You can find the configuration we're using here: `/public/config/docker_openresty-orthanc.js` diff --git a/docs/latest/deployment/recipes/user-account-control.md b/docs/latest/deployment/recipes/user-account-control.md index d22648a60..609c54995 100644 --- a/docs/latest/deployment/recipes/user-account-control.md +++ b/docs/latest/deployment/recipes/user-account-control.md @@ -125,10 +125,10 @@ likely want to update: The OHIF Viewer's configuration is imported from a static `.js` file and made available globally at `window.config`. The configuration we use is set to a specific file when we build the viewer, and determined by the env variable: -`REACT_APP_CONFIG`. You can see where we set its value in the `dockerfile` for -this solution: +`APP_CONFIG`. You can see where we set its value in the `dockerfile` for this +solution: -`ENV REACT_APP_CONFIG=config/docker_openresty-orthanc-keycloak.js` +`ENV APP_CONFIG=config/docker_openresty-orthanc-keycloak.js` You can find the configuration we're using here: `/public/config/docker_openresty-orthanc-keycloak.js` @@ -281,9 +281,9 @@ community members put together: [orthanc-docs]: http://book.orthanc-server.com/users/configuration.html#configuration [lua-resty-openidc-docs]: https://github.com/zmartzone/lua-resty-openidc -[config]: # -[dockerfile]: # -[config-nginx]: # -[config-orthanc]: # -[config-keycloak]: # +[config]: https://github.com/OHIF/Viewers/blob/master/platform/viewer/src/config.js +[dockerfile]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes +[config-nginx]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes +[config-orthanc]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes +[config-keycloak]: https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes diff --git a/docs/latest/essentials/configuration.md b/docs/latest/essentials/configuration.md index cd87a9ba3..2b43a55f3 100644 --- a/docs/latest/essentials/configuration.md +++ b/docs/latest/essentials/configuration.md @@ -7,11 +7,11 @@ ## How it Works The configuration for our project is in the `/public/config` directory. Our -build process knows which configuration file to use based on the -`REACT_APP_CONFIG` environment variable. By default, its value is -[`default.js`](https://github.com/OHIF/Viewers/blob/react/public/config/default.js). -When we build, the `%REACT_APP_CONFIG%` value in -our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/react/public/index.html#L12-L15) +build process knows which configuration file to use based on the `APP_CONFIG` +environment variable. By default, its value is +[`default.js`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/config/default.js). +When we build, the `%APP_CONFIG%` value in +our[`/public/index.html`](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/index.html) file is substituted for the correct configuration file's name. This sets the `window.config` equal to our configuration file's value. @@ -40,17 +40,17 @@ window.config = { }, ], }, -} +}; ``` You can also create a new config file and specify its path relative to the build -output's root by setting the `REACT_APP_CONFIG` environment variable. You can -set the value of this environment variable a few different ways: +output's root by setting the `APP_CONFIG` environment variable. You can set the +value of this environment variable a few different ways: - [Add a temporary environment variable in your shell](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-temporary-environment-variables-in-your-shell) - [Add environment specific variables in `.env` file(s)](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#adding-development-environment-variables-in-env) - Using the `cross-env` package in an npm script: - - `"build": "cross-env REACT_APP_CONFIG=config/my-config.js react-scripts build"` + - `"build": "cross-env APP_CONFIG=config/my-config.js react-scripts build"` After updating the configuration, `yarn run build:web` to generate updated build output. diff --git a/docs/latest/essentials/data-source.md b/docs/latest/essentials/data-source.md index 2cc00c2dc..2c1b68b2b 100644 --- a/docs/latest/essentials/data-source.md +++ b/docs/latest/essentials/data-source.md @@ -60,8 +60,8 @@ _Upload your first Study:_ #### Orthanc: Learn More You can see the `docker-compose.yml` file this command runs at -[`/docker/Nginx-Docker/`](#), and more on Orthanc for Docker in -[Orthanc's documentation][orthanc-docker]. +[`/platform/viewer/.recipes/Nginx-Orthanc/`](https://github.com/OHIF/Viewers/tree/master/platform/viewer/.recipes/Nginx-Orthanc), +and more on Orthanc for Docker in [Orthanc's documentation][orthanc-docker]. ### Connecting to Orthanc @@ -87,19 +87,18 @@ is running the `dev:orthanc` script in our project's `package.json`. That script is: ```js -cross-env PORT=5000 REACT_APP_CONFIG=config/docker_nginx-orthanc.js react-scripts start +cross-env PORT=5000 APP_CONFIG=config/docker_nginx-orthanc.js react-scripts start ``` - `cross-env` sets two environment variables - PORT: 5000 - - REACT_APP_CONFIG: `config/docker_nginx-orthanc.js` + - APP_CONFIG: `config/docker_nginx-orthanc.js` - `react-scripts` runs it's `start` script. This is [the de-facto way][cra-start] to run a "Create React App" in development mode. -The `REACT_APP_CONFIG` value tells our app which file to load on to -`window.config`. By default, our app uses the file at -`/public/config/default.js`. Here is what that configuration looks -like: +The `APP_CONFIG` value tells our app which file to load on to `window.config`. +By default, our app uses the file at `/public/config/default.js`. +Here is what that configuration looks like: ```js window.config = { diff --git a/docs/latest/frequently-asked-questions.md b/docs/latest/frequently-asked-questions.md index eec5c1a3f..7dea3a284 100644 --- a/docs/latest/frequently-asked-questions.md +++ b/docs/latest/frequently-asked-questions.md @@ -37,8 +37,8 @@ Some tips for filing a new issue: At the moment we are in the process of defining our roadmap and will do our best to communicate this to the community. If your requested feature is on the roadmap, then it will most likely be built at some point. If it is not, you are -welcome to build it yourself and [contribute it](../contributing.md). If you -have resources and would like to fund the development of a feature, please +welcome to build it yourself and [contribute it](contributing.md). If you have +resources and would like to fund the development of a feature, please [contact us](http://www.ohif.org). ### Who should I contact about Academic Collaborations? diff --git a/platform/viewer/.recipes/Nginx-Dcm4che/docker-compose-dcm4che.yml b/platform/viewer/.recipes/Nginx-Dcm4che/docker-compose-dcm4che.yml index 5a34ff182..40b6d8efe 100644 --- a/platform/viewer/.recipes/Nginx-Dcm4che/docker-compose-dcm4che.yml +++ b/platform/viewer/.recipes/Nginx-Dcm4che/docker-compose-dcm4che.yml @@ -69,7 +69,7 @@ services: # - orthanc environment: - NODE_ENV=production - - REACT_APP_CONFIG=config/local_dcm4chee + - APP_CONFIG=config/local_dcm4chee restart: always networks: - dcm4che_default diff --git a/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/dockerfile b/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/dockerfile index 6019d6790..73090e8ae 100644 --- a/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/dockerfile +++ b/platform/viewer/.recipes/OpenResty-Orthanc-Keycloak/dockerfile @@ -28,7 +28,7 @@ FROM node:11.2.0-slim as builder RUN mkdir /usr/src/app WORKDIR /usr/src/app -ENV REACT_APP_CONFIG=config/docker_openresty-orthanc-keycloak.js +ENV APP_CONFIG=config/docker_openresty-orthanc-keycloak.js ENV PATH /usr/src/app/node_modules/.bin:$PATH COPY package.json /usr/src/app/package.json diff --git a/platform/viewer/.recipes/OpenResty-Orthanc/dockerfile b/platform/viewer/.recipes/OpenResty-Orthanc/dockerfile index 6b96885cf..1a9c8ec59 100644 --- a/platform/viewer/.recipes/OpenResty-Orthanc/dockerfile +++ b/platform/viewer/.recipes/OpenResty-Orthanc/dockerfile @@ -28,7 +28,7 @@ FROM node:11.2.0-slim as builder RUN mkdir /usr/src/app WORKDIR /usr/src/app -ENV REACT_APP_CONFIG=config/docker_openresty-orthanc.js +ENV APP_CONFIG=config/docker_openresty-orthanc.js ENV PATH /usr/src/app/node_modules/.bin:$PATH COPY package.json /usr/src/app/package.json diff --git a/platform/viewer/CHANGELOG.md b/platform/viewer/CHANGELOG.md index ad3f98023..ff9dcbb40 100644 --- a/platform/viewer/CHANGELOG.md +++ b/platform/viewer/CHANGELOG.md @@ -3,6 +3,25 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [0.50.5](https://github.com/OHIF/Viewers/compare/@ohif/viewer@0.50.4...@ohif/viewer@0.50.5) (2019-08-21) + + +### Bug Fixes + +* **StandaloneRouting:** Promise rejection - added `return` ([#791](https://github.com/OHIF/Viewers/issues/791)) ([d09fb4e](https://github.com/OHIF/Viewers/commit/d09fb4e)) + + + + + +## [0.50.4](https://github.com/OHIF/Viewers/compare/@ohif/viewer@0.50.3...@ohif/viewer@0.50.4) (2019-08-20) + +**Note:** Version bump only for package @ohif/viewer + + + + + ## [0.50.3](https://github.com/OHIF/Viewers/compare/@ohif/viewer@0.50.2...@ohif/viewer@0.50.3) (2019-08-15) **Note:** Version bump only for package @ohif/viewer diff --git a/platform/viewer/package.json b/platform/viewer/package.json index f97a26dae..50fd43a6b 100644 --- a/platform/viewer/package.json +++ b/platform/viewer/package.json @@ -1,6 +1,6 @@ { "name": "@ohif/viewer", - "version": "0.50.3", + "version": "0.50.5", "description": "OHIF Viewer", "author": "OHIF Contributors", "license": "MIT", diff --git a/platform/viewer/src/routes/StandaloneRouting.js b/platform/viewer/src/routes/StandaloneRouting.js index 7721c71d9..a898a39a4 100644 --- a/platform/viewer/src/routes/StandaloneRouting.js +++ b/platform/viewer/src/routes/StandaloneRouting.js @@ -26,7 +26,7 @@ class StandaloneRouting extends Component { const url = query.url; if (!url) { - reject(new Error("No URL was specified. Use ?url=$yourURL")); + return reject(new Error("No URL was specified. Use ?url=$yourURL")); } // Define a request to the server to retrieve the study data