Web SDK
Introduction

Introduction to Web SDK Tutorials

Welcome to the Web SDK Tutorials section! This section is designed to help you get started with our Web SDK and guide you through various tasks and features step-by-step. Whether you are a beginner or an experienced developer, these tutorials will provide you with the knowledge and skills needed to effectively integrate our AR capabilities into your web applications.

What is the Web SDK?

Our Web SDK is a powerful toolkit that allows you to integrate augmented reality (AR) features into your web applications with ease. It provides a set of APIs and tools that enable you to build rich, interactive AR experiences directly in the browser, leveraging the full capabilities of our platform.

Why Use the Web SDK?

  • Ease of Integration: Quickly set up and integrate AR features into your web projects.
  • Comprehensive Functionality: Access a wide range of AR features and functionalities through our well-documented API.
  • Real-time Rendering: Fetch and update AR data in real-time for a seamless user experience.
  • Cross-browser Compatibility: Ensure a consistent AR experience across all modern web browsers.
  • Extensive Documentation and Support: Benefit from detailed guides, examples, and support to help you at every step of the integration process.

What You Will Learn

In this series of tutorials, you will learn how to:

  1. Set Up the SDK: Install and configure the Web SDK in your project.
  2. Create AR Scenes: Use the SDK to create and manage AR scenes in your web application.
  3. Add AR Objects: Integrate AR objects into your scenes.
  4. Different Modes: Work with different modes like camera (live) and model (static) mode.

Prerequisites

Before you begin, make sure you have the following:

  • Basic Knowledge of JavaScript/TypeScript: Familiarity with JavaScript or TypeScript is essential.
  • Node.js and npm/yarn Installed: You will need Node.js and npm or yarn installed on your machine to manage dependencies.
  • Unique Brand Key: Obtain a brand ID key from your mirrAR POC.

Getting Started

To get started with our tutorials, follow the steps below:

  1. Read the Getting Started Guide: This guide will help you set up the Web SDK and prepare your development environment.
  2. Explore the Tutorials: Navigate through the tutorials to learn about different AR features and functionalities.

Resources

For additional information and support, check out the following resources:

  • API Reference: Detailed documentation of all the API required to work with the Web SDK.
  • Features: List of features in our web SDK.

We hope you find these tutorials helpful and look forward to seeing what you build with our Web SDK!


Happy coding!

The mirrAR Team