Setting up the development environment 👷🏽‍

Thank you for interest in contributing 🤝

To easily get started, clone the repository:

git clone https://github.com/vimeo/vimeo-threejs-player.git

Once you have it cd vimeo-threejs-player 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 development server run:

yarn run server

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

yarn run build:watch

Full list of build commands available here

Testing:

If you are contributing please write tests for your additions, tests are stored in spec/. To run the test server, run:

yarn run test

Which should spawn a second test server in localhost:4444/spec where you can see the test-runner

---

Having issues? ask on StackOverflow