If you intend to contribute back changes, or if you would like to pull updates we make to the OHIF Viewer, then follow these steps:
- Fork the OHIF/Viewers repository
- Create a local clone of your fork
git clone https://github.com/YOUR-USERNAME/Viewers
- Add OHIF/Viewers as a remote repository labled
- Navigate to the cloned project's directory
git remote add upstream https://github.com/OHIF/Viewers.git
With this setup, you can now sync your fork to keep it up-to-date with the upstream (original) repository. This is called a "Triangular Workflow" and is common for Open Source projects. The GitHub blog has a good graphic that illustrates this setup.
Alternatively, if you intend to use the OHIF Viewer as a starting point, and you aren't as concerned with syncing updates, then follow these steps:
- Navigate to the OHIF/Viewers repository
Clone or download, and then
- Use the contents of the
.zipfile as a starting point for your viewer
NOTE: It is still possible to sync changes using this approach. However, submitting pull requests for fixes and features are best done with the separate, forked repository setup described in "Fork & Clone"
Navigate to the root of the project's directory in your terminal and run the following commands:
# Restore dependencies yarn install # Start local development server yarn run dev
You should see the following output:
@ohif/viewer: i ｢wds｣: Project is running at http://localhost:3000/ @ohif/viewer: i ｢wds｣: webpack output is served from / @ohif/viewer: i ｢wds｣: Content not from webpack is served from D:\code\ohif\Viewers\platform\viewer @ohif/viewer: i ｢wds｣: 404s will fallback to /index.html # And a list of all generated files
More comprehensive guides for building and publishing can be found in our deployment docs
# Build static assets to host a PWA yarn run build # Build packaged output (script-tag use) yarn run build:package
Take a look at the sidebar. Depending on how you intend to use The OHIF Viewer, different topics may be more pertinent than others. At a minimum, reading "The Essentials" and the deployment recipes should be a good starting point.
- If you receive a "No Studies Found" message and do not see your studies, try changing the Study Date filters to a wider range.
- If you see any errors in your server console, check the Troubleshooting page for more in depth advice.