Pixel-perfect | High-DPI-ready | Fast 🚀 | Hackable | Consistent |
---|
FSI Layers renders any number of images as layers in a canvas. The real-time scaling capabilities of the image server are used to achieve pixel-perfect results. All layers can be animated and blended. FSI Layers can be created and controlled as a simple HTML tag and/or via JavaScript API.
This repository contains examples on how to use and build your own applications.
Without starting this project in your IDE, you can discover all the demos on the GitHub Pages or develop and customise in StackBlitz.
To run and modify this samples:
npm install
npm start
or
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.
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 Layers!
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.
For further information on the FSI Viewer and FSI Server, please refer to the official documentation.