191 lines
6.9 KiB
Markdown
191 lines
6.9 KiB
Markdown
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<div align="center">
|
|
<h1>ohif-viewer</h1>
|
|
<p><strong>ohif-viewer</strong> is a zero-footprint medical image viewer. It is a configurable and exstensible progressive web application with out of the box support for PACS like orthanc, dcm4che, and Google's Healthcare API.</p>
|
|
</div>
|
|
|
|
|
|
<div align="center">
|
|
<a href="https://deploy-preview-398--ohif.netlify.com/"><strong>Read The Docs</strong></a> |
|
|
<a href="https://github.com/OHIF/Viewers/tree/react/docs/latest">Edit the docs</a>
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
|
|
[![CircleCI][circleci-image]][circleci-url]
|
|
[![codecov][codecov-image]][codecov-url]
|
|
[![All Contributors][all-contributors-image]][contributing-url]
|
|
[![code style: prettier][prettier-image]][prettier-url]
|
|
[![semantic-release][semantic-image]][semantic-url]
|
|
|
|
[![NPM version][npm-version-image]][npm-url]
|
|
[![NPM downloads][npm-downloads-image]][npm-url]
|
|
[![MIT License][license-image]][license-url]
|
|
<!-- markdownlint-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Why?
|
|
|
|
Building a web based medical imaging viewer from scratch is time intensive, hard
|
|
to get right, and expensive. Instead of re-inventing the wheel, you can use the
|
|
OHIF Viewer as a rock solid platform to build on top of. The Viewer is a
|
|
[React][react-url] [Progressive Web Application][pwa-url] that can be embedded
|
|
in existing applications via it's [packaged source
|
|
(ohif-viewer)][ohif-viewer-url] or hosted stand-alone. The Viewer exposes
|
|
[configuration][configuration-url] and [extensions][extensions-url] to support
|
|
workflow customization and advanced functionality at common integration points.
|
|
|
|
If you're interested in using the OHIF Viewer, but you're not sure it supports
|
|
your use case
|
|
[check out our docs](https://deploy-preview-398--ohif.netlify.com/). Still not
|
|
sure, or you would like to propose new features? Don't hesitate to
|
|
[create an issue](https://github.com/OHIF/Viewers/issues) or open a pull request
|
|
^\_^
|
|
|
|
## Getting Started
|
|
|
|
This readme is specific to testing and developing locally. If you're more
|
|
interested in production deployment strategies,
|
|
[you can check out our documentation on publishing](https://deploy-preview-398--ohif.netlify.com/).
|
|
|
|
Want to play around before you dig in?
|
|
[Check out our LIVE Demo](https://viewer.ohif.org/)
|
|
|
|
### Setup
|
|
|
|
_Requirements:_
|
|
|
|
- [NodeJS & NPM](https://nodejs.org/en/download/)
|
|
- [Yarn](https://yarnpkg.com/lang/en/docs/install/)
|
|
|
|
_Steps:_
|
|
|
|
1. Fork this repository
|
|
2. Clone your forked repository (your `origin`)
|
|
|
|
- `git clone git@github.com:YOUR_GITHUB_USERNAME/Viewers.git`
|
|
|
|
3. Add `OHIF/Viewers` as a `remote` repository (the `upstream`)
|
|
|
|
- `git remote add upstream git@github.com:OHIF/Viewers.git`
|
|
|
|
### Developing Locally
|
|
|
|
In your cloned repository's root folder, run:
|
|
|
|
```js
|
|
// Restore dependencies
|
|
yarn install
|
|
|
|
// Stands up local server to host Viewer.
|
|
// Viewer connects to our public cloud PACS by default
|
|
yarn start
|
|
```
|
|
|
|
For more advanced local development scenarios, like using your own locally
|
|
hosted PACS and test data,
|
|
[check out our Essential: Getting Started](https://deploy-preview-398--ohif.netlify.com/essentials/getting-started.html)
|
|
guide.
|
|
|
|
### Contributing
|
|
|
|
> Large portions of the Viewer's functionality are maintained in other
|
|
> repositories. To get a better understanding of the Viewer's architecture and
|
|
> "where things live", read
|
|
> [our docs on the Viewer's architecture](https://deploy-preview-398--ohif.netlify.com/advanced/architecture.html#diagram)
|
|
|
|
It is notoriously difficult to setup multiple dependent repositories for
|
|
end-to-end testing and development. That's why we recommend writing and running
|
|
unit tests when adding and modifying features. This allows us to program in
|
|
isolation without a complex setup, and has the added benefit of producing
|
|
well-tested business logic.
|
|
|
|
1. Clone this repository
|
|
2. Navigate to the project directory, and `yarn install`
|
|
3. To begin making changes, `yarn run dev`
|
|
4. To commit changes, run `yarn run cm`
|
|
|
|
When creating tests, place the test file "next to" the file you're testing.
|
|
[For example](https://github.com/OHIF/Viewers/blob/react/src/index.test.js):
|
|
|
|
```js
|
|
// File
|
|
index.js
|
|
|
|
// Test for file
|
|
index.test.js
|
|
```
|
|
|
|
As you add and modify code, `jest` will watch for uncommitted changes and run
|
|
your tests, reporting the results to your terminal. Make a pull request with
|
|
your changes to `master`, and a core team member will review your work. If you
|
|
have any questions, please don't hesitate to reach out via a GitHub issue.
|
|
|
|
## Issues
|
|
|
|
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
|
|
label._
|
|
|
|
### 🐛 Bugs
|
|
|
|
Please file an issue for bugs, missing documentation, or unexpected behavior.
|
|
|
|
[**See Bugs**][bugs]
|
|
|
|
### 💡 Feature Requests
|
|
|
|
Please file an issue to suggest new features. Vote on feature requests by adding
|
|
a 👍. This helps maintainers prioritize what to work on.
|
|
|
|
[**See Feature Requests**][requests-feature]
|
|
|
|
### ❓ Questions
|
|
|
|
For questions related to using the library, please visit our support community,
|
|
or file an issue on GitHub.
|
|
|
|
[Google Group][google-group]
|
|
|
|
## License
|
|
|
|
MIT © [OHIF](https://github.com/OHIF)
|
|
|
|
<!--
|
|
Links:
|
|
-->
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- ROW -->
|
|
[all-contributors-image]: https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square
|
|
[contributing-url]: https://github.com/OHIF/Viewers/blob/react/CONTRIBUTING.md
|
|
[circleci-image]: https://circleci.com/gh/OHIF/Viewers.svg?style=svg
|
|
[circleci-url]: https://circleci.com/gh/OHIF/Viewers
|
|
[codecov-image]: https://codecov.io/gh/OHIF/Viewers/branch/react/graph/badge.svg
|
|
[codecov-url]: https://codecov.io/gh/OHIF/Viewers
|
|
[prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
|
|
[prettier-url]: https://github.com/prettier/prettier
|
|
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
|
|
[semantic-url]: https://github.com/semantic-release/semantic-release
|
|
<!-- ROW -->
|
|
[npm-url]: https://npmjs.org/package/ohif-viewer
|
|
[npm-downloads-image]: https://img.shields.io/npm/dm/ohif-viewer.svg?style=flat-square
|
|
[npm-version-image]: https://img.shields.io/npm/v/ohif-viewer.svg?style=flat-square
|
|
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
|
|
[license-url]: LICENSE
|
|
<!-- DOCS -->
|
|
[react-url]: https://reactjs.org/
|
|
[pwa-url]: https://developers.google.com/web/progressive-web-apps/
|
|
[ohif-viewer-url]: https://www.npmjs.com/package/ohif-viewer
|
|
[configuration-url]: https://deploy-preview-398--ohif.netlify.com/essentials/configuration.html
|
|
[extensions-url]: https://deploy-preview-398--ohif.netlify.com/advanced/extensions.html
|
|
<!-- Misc. -->
|
|
[react-viewer]: https://github.com/OHIF/Viewers/tree/react
|
|
<!-- Issue Boilerplate -->
|
|
[bugs]: https://github.com/OHIF/Viewers/labels/bug
|
|
[requests-feature]: https://github.com/OHIF/Viewers/labels/enhancement
|
|
[good-first-issue]: https://github.com/OHIF/Viewers/labels/good%20first%20issue
|
|
[google-group]: https://groups.google.com/forum/#!forum/cornerstone-platform
|
|
<!-- prettier-ignore-end -->
|