UNPKG

@tindtechnologies/universalviewer

Version:

The Universal Viewer is a community-developed open source project on a mission to help you share your 📚📜📰📽️📻🗿 with the 🌎

140 lines (95 loc) 6.1 kB
# TIND Universal Viewer TIND Universal Viewer is a fork of [Universal Viewer](https://github.com/UniversalViewer/universalviewer). It contains the following changes: - Removes bundled jQuery by changing all occurrences of `require("jquery")` with `window.$`. - Removes GitHub Workflows. ## Publishing Publishing is done manually. Here is how. 1. Make sure you are on the latest `develop` branch ```shell git checkout develop git fetch git reset --hard origin/develop ``` 2. Bump the version. Note: this creates and tags a commit which should be pushed. ```shell npm version prerelease --preid=alpha git push origin develop ``` 3. Install NPM dependencies ```shell npm ci ``` 4. Build the assets ```shell npm run build && npm run build-tsc && npm run build-es ``` 5. Publish ```shell export NPM_TOKEN=<your token here> npm publish --access public --otp <2fa one time code here> ``` ---- <p align="center"> <img src="https://avatars0.githubusercontent.com/u/9430521" style="width: 150px;" /> <h1 align="center" style="width: 60%; margin-left: auto; margin-right: auto;">Universal Viewer</h1> <p align="center"> A community-developed open source project on a mission<br/> to help you share your 📚📜📰📽️📻🗿 with the 🌎 </p> </p> <br/> <p align="center"> <a href="#-sponsors"><img src="https://camo.githubusercontent.com/db8439fd8526d52fbc36437f988d0d8d8dd6913a/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f756e6976657273616c7669657765722f73706f6e736f72732f62616467652e737667" alt="Sponsors on Open Collective" data-canonical-src="https://opencollective.com/universalviewer/sponsors/badge.svg" style="max-width:100%;" /></a> <a href="https://app.netlify.com/sites/uv/deploys"> <img src="https://api.netlify.com/api/v1/badges/91dc58e8-49dd-495f-98bb-84570a0edb7c/deploy-status" /> </a> <a href="https://github.com/UniversalViewer/universalviewer/blob/main/LICENSE.txt"><img src="https://camo.githubusercontent.com/e80e20b31b4af7da8580f68d415779d250eee229/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f6c2f74687265652e737667" alt="License" data-canonical-src="https://img.shields.io/npm/l/universalviewer.svg" style="max-width:100%;"></a> </p> <p align="center"> <a href="https://docs.google.com/forms/d/e/1FAIpQLSeHLD0kng5aXvGFsNN_tJGsZMTnp08Hv2F6kdGsJRb6bT0NWw/viewform" rel="nofollow"><strong>#</strong> slack</a>&nbsp;&nbsp;&nbsp;&nbsp; <a href="https://x.com/universalviewer"><strong>@</strong> X</a> </p> <br/> npm install universalviewer --save <br/> > Please note that UV v4 is designed to work on [evergreen browsers](https://www.w3.org/2001/tag/doc/evergreen-web/). If you need IE11 support, please use [UV v3](https://github.com/UniversalViewer/universalviewer/tree/v3). > Microsoft no longer supports IE11, and it [reached end-of-life on June 15 2022](https://blogs.windows.com/windowsexperience/2021/05/19/the-future-of-internet-explorer-on-windows-10-is-in-microsoft-edge/). <br/> - [TIND Universal Viewer](#tind-universal-viewer) - [Publishing](#publishing) - [🌐 Website](#-website) - [📖 Getting Started](#-getting-started) - [💻 Contributing](#-contributing) - [🏅 Sponsors](#-sponsors) - [📖 License](#-license) - [📖 Accessibility Statement](#-accessibility-statement) - [📣 Feedback](#-feedback) ## 🌐 Website - [Visit Universal Viewer website](https://universalviewer.io/) - [Visit the stable UV demo page](https://uv-v4.netlify.app) to try out the latest stable version of the Viewer (UV4) with sample items. - [Visit the dev branch UV demo page](https://universalviewer.dev) to try out the latest 'bleeding edge' dev branch code for UV4. - [View sample items in version 3 of the Universal Viewer](https://uv-v3.netlify.app) <!-- ## 📖 Scope Read more [about the Universal Viewer](https://github.com/UniversalViewer/universalviewer/wiki/About) --> ## 📖 Getting Started See the [examples](https://github.com/UniversalViewer/universalviewer/wiki/UV-Examples) for how to use the UV in various scenarios. Read the technical [docs](https://docs.universalviewer.io/modules.html) to learn more about the code and available configuration options. ## 💻 Contributing Read below to learn how to take part in improving the UV: - Fork the repository and [run the examples from source](#-getting-started) - Get familiar with [Code of Conduct](https://github.com/UniversalViewer/universalviewer/blob/main/CODE_OF_CONDUCT.md) - Read our [guide to contributing](https://github.com/UniversalViewer/universalviewer/blob/main/CONTRIBUTING.md) - Find an [issue](https://github.com/UniversalViewer/universalviewer/issues) to work on and submit a pull request - Could not find an issue? Look for bugs, typos, and missing features. ![Contributors](https://raw.githubusercontent.com/UniversalViewer/assets/master/contributors.jpg "Contributors") <a href="https://github.com/UniversalViewer/universalviewer/graphs/contributors"><img src="https://opencollective.com/universalviewer/contributors.svg?width=890&button=false" /></a> ## 🏅 Sponsors [Become a sponsor](https://opencollective.com/universalviewer#sponsor) and join our [Steering Group](https://github.com/UniversalViewer/universalviewer/wiki/Steering-Group) to help guide how our sponsorship funds are allocated. ## 📖 License The Universal Viewer is released under the [MIT license](https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt). ## 📖 Accessibility Statement Read our [Accessibility Statement](https://github.com/UniversalViewer/universalviewer/wiki/Accessibility-Statement-for-the-Universal-Viewer) ## 📣 Feedback Read below how to engage with the UV [community](https://github.com/UniversalViewer/universalviewer/blob/main/COMMUNITY_TEAM.md): - Join the discussion on [Slack](http://universalviewer.io/#contact). - Ask a question, request a new feature and file a bug with [GitHub issues](https://github.com/universalviewer/universalviewer/issues/new). - Star the repository to show your support ⭐