neptunelabs / fsi-viewer-samples

Example repository for responsive images with FSI Viewer, used in conjunction with FSI Server for product view and zoom, detailed views, full-screen images or pixel-perfect product display. ⭐️ Star to support our work!

FSI Viewer Samples

Pixel-perfect	High-DPI-ready	Fast 🚀	Hackable	Consistent

---

• Live Samples @ GitHub Pages 🔗
• FSI Viewer - Product Page 🔗
• Documentation 🔗

The zoom viewer provides a minimalist, highly customisable user interface that is easily adaptable via CSS, supported by lightning-fast real-time image delivery from the FSI Server. FSI Viewer can be created and controlled as a simple HTML tag and/or via the JavaScript API.

This repository contains examples on how to use and build your own applications.

Getting Started

Without starting this project in your IDE, you can discover all the demos on the GitHub Pages or develop and customise in StackBlitz.

Start and develop

To run and modify this samples:

NPM

npm install
npm start

or

Yarn

yarn
yarn start

Now you can customize the demo according to your own preferences or develop something new.

You can find a very simple example to start with in the samples/starter folder.

How it works

These examples rely on a framework that uses Grunt, Browsersync, Bootstrap and Sass to launch a local server, replace template variables and pass changes directly to the browser window.

However, these dependencies are generally not required for the use of FSI Server!

Requirements

To run the demo you do not need your own image server. If you don't have your own server but still want to use your own images, you can use an evaluation copy indefinitely. In case of an own server, please copy env.yml.dist to env.yml and change the settings.

Documentation

For further information on the FSI Viewer and FSI Server, please refer to the official documentation.