@ohif/viewer is a zero-footprint medical image viewer provided by the Open Health Imaging Foundation (OHIF). It is a configurable and extensible progressive web application with out-of-the-box support for image archives which support DICOMweb.
!NPM versionnpm-version-imagenpm-url !NPM downloadsnpm-downloads-imagenpm-url !Pullsdocker-pulls-imgdocker-image-url !MIT Licenselicense-imagelicense-url
ATTENTION: If you are looking for Version 1 (the Meteor Version) of this repository, it lives on the
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 Reactreact-url Progressive Web Applicationpwa-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 configurationconfiguration-url and extensionsextensions-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. Still not sure, or you would like to propose new features? Don't hesitate to create an issue or open a pull request.
Getting StartedThis 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.
Want to play around before you dig in? Check out our LIVE Demo
- Fork this repository
- Clone your forked repository (your
git clone firstname.lastname@example.org:YOUR_GITHUB_USERNAME/Viewers.git
git remote add upstream email@example.com:OHIF/Viewers.git
Developing LocallyIn your cloned repository's root folder, run:
// 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 guide.
E2E TestsUsing Cypress to create End-to-End tests and check whether the application flow is performing correctly, ensuring that the integrated components are working as expected.
Why Cypress?Cypress is a next generation front end testing tool built for the modern web. With Cypress is easy to set up, write, run and debug tests
It allow us to write different types of tests:
- End-to-End tests
- Integration tests
- Unit tets
All tests must be in
Commands to run the tests:
// Open Cypress Dashboard that provides insight into what happened when your tests ran yarn test:e2e // Run all tests using Electron browser headless yarn test:e2e:local // Run all tests in CI mode yarn run test:e2e:ci
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
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.
- Clone this repository
- Navigate to the project directory, and
- To begin making changes,
yarn run dev
- To commit changes, run
yarn run cm
When creating tests, place the test file "next to" the file you're testing. For example:
// File index.js; // Test for file index.test.js;
As you add and modify code,
jestwill 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.
ContributorsThanks goes to these wonderful people (emoji key):
Gustavo André Lelis
João Felipe de Medeiros Moreira
This project follows the all-contributors specification. Contributions of any kind welcome!