Code Monkey home page Code Monkey logo

marzipano's Introduction

Marzipano

A 360° media viewer for the modern web.

This is not an official Google product.

Check out our website at http://www.marzipano.net/, including the demos and the documentation.

User guide

You can include Marzipano in your project in two different ways:

  • Obtain the marzipano.js and marzipano.swf files from the latest release at http://www.marzipano.net and copy them into your project.

  • Install Marzipano as a dependency using the npm package manager and require it as a module.

Developer guide

This is an npm-based project. A Node.js installation is required for development. You also need a Java compiler to build the SWF file containing the Flash renderers. (Set 32-bit Java path in your PATH, as MXMLC does not support 64-bit Java)

Run npm install to install the dependencies. If you haven't in a while, bring them up to date with npm update.

Run npm run dev to serve this directory at http://localhost:8080. While this script is running, the demos are live-reloaded whenever the source files are edited.

Run npm run test to serve the browser-based test suite at http://localhost:7357. While this script is running, the test suite is live-reloaded whenever the source or test files are edited.

Maintainer guide

Before preparing a release, make sure there are no uncommitted changes. Create a new commit to bump the version number in package.json and tag it with git tag vX.Y.Z.

Run npm run release to prepare a new release.

Run npm run deploy to deploy the release to the website.

Run npm publish to publish the release to the npm registry.

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.