Giter Club home page Giter Club logo

fari's Introduction

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

fari's People

Contributors

maxmmueller avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.