Skip to main content

DeepAR Web SDK Demo Project

We have a demo project setup on GitHub that lets you test out DeepAR really quickly and it serves as a getting started project.

You can find DeepAR Web Quickstart project on GitHub!

Preview of demo project​

You can view this demo project here!

Run demo project locally​

  1. Clone the project:
git clone https://github.com/DeepARSDK/quickstart-web-js-npm.git
  1. Install DeepAR Web and Webpack with NPM:
npm install

  1. Obtain License key

    1. On developer portal, go to projects and click + New Project.
    2. Enter the name of your project. For example "My First AR App".
    3. Choose a FREE plan.
    4. Under Web App choose + Add App.
    5. Enter the domain name under which you plan to deploy your app.

      ⚠️ IMPORTANT ⚠️
      You need to enter the DOMAIN NAME, not the URL where your app is running.
      For example, if your app is running on
      > https://www.domain.com/try-on/glasses
      the domain you need to enter is www.domain.com.
      Be sure to leave out any protocol name (like https) and additional paths (like try-on/glasses).

  2. Copy the generated license key in the src/index.js instead of "your_license_key_goes_here"

  3. Run the demo.

npm run dev

If the browser doesn't open automatically, open http://localhost:8888.

Other demo projects​