README.md

Banuba SDK Web AR demo app

Requirements

• Banuba client token
• Nodejs installed
• Browser with support of WebGL 2.0

Obtaining Banuba SDK Web AR

The example uses CDN version of the @banuba/webar npm package for simplicity. Please use the npm package mentioned above for real world projects. Check out the Integration tutorials for more ways of consuming @banuba/webar package.

Obtaining Banuba Client token

Banuba Client token is required to get Banuba SDK Web AR working.

To receive a new trial client token please fill in the form on banuba.com website, or contact us via info@banuba.com.

Environment setup and local run

Clone the repository

git clone git@github.com:Banuba/quickstart-web.git

Insert Banuba client token into BanubaClientToken.js

window.BANUBA_CLIENT_TOKEN = "PUT YOUR CLIENT TOKEN HERE";

Run the live server in the cloned folder

npx live-server

Open localhost:8080

Adding a new effect

Put effect zip file to import/ folder and add zip file name to ./import/effectsList.js file. Example:

export const importedEffectsList = ["your_effect_1.zip", "your_effect_2.zip"];

You can obtain more effects on the Demo Face Filters page.

---

Learn more about Banuba WebAR SDK on the Web section of docs.banuba.com.