Skip to content

A lightweight JavaScript library for creating virtual tours

License

Notifications You must be signed in to change notification settings

maxmmueller/Fari

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fari

A lightweight JavaScript library for creating virtual tours

Features

With Fari, you can easily integrate virtual tours into your own websites or Node.js projects.

Installation

Method 1: You can install Fari from the node package manager:

$ npm install fari

Method 2: Alternatively you can bundle the code yourself. To do so, simply download the latest release, navigate to the fari directory in your terminal and run:

$ npm install
$ npm run build

This will create the dist directory containing the bundled code from which you can import.

Usage

Read the documentation to learn how to use this library.

Code example:

import { VirtualTour } from "fari";

const tour = new VirtualTour("tour-div", "tour_structure.json");
tour.start();

Contributing

Contributions to this project are welcome!

If you encounter any problems, find a bug or have feature requests, please open an issue.

Support

If you find this project helpful, consider supporting its development by making a donation:

Buy Me A Coffee