neptunelabs / fsi-image-samples

Example repository for responsive images, used in conjunction with FSI Server for pixel-perfect product display, detailed views, complete replacement for pre-rendered images or dynamic image quality and encoding. ⭐️ Star to support our work!

Auto-generated Responsive Image Samples

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

---

• Live Samples @ GitHub Pages 🔗
• Auto-generated Responsive Images - Product Page 🔗
• Documentation 🔗

Auto-generated Responsive Imaging with FSI Server lets you change your images at any size, at any time - simply by changing the URL. All you need is a high-resolution image - FSI Server creates the desired image sizes, cropping and effects in an instant. Responsive Imaging can be applied to any image on the site.

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 install

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 using images with FSI Server!

Requirements with own images

The images are loaded from an image server (FSI server) in dynamic resolution. In addition, depending on the sample, static assets such as JavaScript, CSS or static images may also be required. In this demo, images and static assets are loaded from an example server. For your own images with these examples in this repository, a separate image server instance is required.

To do this quickly, you can use an evaluation copy for an unlimited period of time.

The recommended way to quickly start your own instance via Docker is described in this repository.

If you have your own server, copy env.yml.dist to env.yml and change the settings according to your FSI server URL.

Documentation

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