https://github.com/maxmmueller/fari
A lightweight JavaScript library for creating virtual tours
https://github.com/maxmmueller/fari
360-photo 360-view virtual-tour virtual-tour-creator
Last synced: 4 months ago
JSON representation
A lightweight JavaScript library for creating virtual tours
- Host: GitHub
- URL: https://github.com/maxmmueller/fari
- Owner: maxmmueller
- License: apache-2.0
- Created: 2024-02-07T21:03:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-10T06:53:30.000Z (about 1 year ago)
- Last Synced: 2025-03-27T08:11:11.037Z (10 months ago)
- Topics: 360-photo, 360-view, virtual-tour, virtual-tour-creator
- Language: JavaScript
- Homepage:
- Size: 226 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Fari
A lightweight JavaScript library for creating virtual tours
[View demo 🚀](https://maxmmueller.github.io/faridemo/source/index.html)
## Features
With Fari, you can easily integrate [virtual tours](https://en.wikipedia.org/wiki/Virtual_tour) 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](https://github.com/maxmmueller/Fari/releases/latest), 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](docs/docs.md) to learn how to use this library.
### Code example:
```js
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](https://github.com/maxmmueller/fari/issues/new).
## Support
If you find this project helpful, consider supporting its development by making a donation:
