Getting Started

Setup ​

Fork & Clone ​

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:

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 .

Private ​

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:

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"

Developing ​

Requirements ​

Kick the tires ​

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

🎉 Celebrate 🎉 ​

Building for Production ​

More comprehensive guides for building and publishing can be found in our deployment docs

# Build static assets to host a PWA
yarn run build

Troubleshooting ​