Setting up the development enviorment 👷🏽‍

Thank you for interest in contributing 🤝

To easily get started, clone the repository, make sure to add the --recursive flag at the end:

git clone https://github.com/vimeo/vimeo-webvr-demo.git --recursive

This A-Frame component is a wrapper for our Vimeo three.js player, by adding the recursive flag you are also cloning the three.js repository into ext/

Once you have it cd vimeo-webvr-demo and open your preferred code editor (e.g code ./ to open VSCode).

In the file browser, you should have a .env.sample file. Duplicate it, and rename the new copy .env. This is where we will store all of the environment variables for local development. Your files should look something like

Next, generate your own Vimeo API token to access your videos. You can generate the token here. Once you have the token, copy and paste it into the VIMEO_TOKEN field in your .env file you just created.

You should now be ready to install all the dependencies for the player. To do that, run:

yarn install

To start the server run:

yarn run start

To build the Vimeo three.js player, needed for the A-Frame component run:

yarn run build:threejs

To start webpacking on every change made to the player, run:

yarn run build:watch

---

Having issues? ask on StackOverflow