Docs Menu

Install the Web SDK

This page shows you how to install the Web SDK to use with your application.

Before you begin installation, you need to create an App Services App for your web app to use.

Note

React Native & Node.js SDKs

We also provide SDKs built for React Native and Node.js. Generally, you should use these when creating apps in these environments. Alternatively, you can use the Web SDK for React Native or Node.js apps.

Further reading:

Tip

Atlas Device SDK and Realm

The JS SDKs use the Realm Core database for device data persistence. When you install the Web SDK, the package names reflect Realm naming.

npm install realm-web
yarn add realm-web

Add a <script> tag to the <head> of your HTML file to load the Web SDK as a global variable from a content delivery network.

Use the most recent version:

<script src="https://unpkg.com/realm-web/dist/bundle.iife.js"></script>

Or import a specific version:

<script src="https://unpkg.com/realm-web@1.7.1/dist/bundle.iife.js"></script>

In order to use the Web SDK for Node.js environments, you must install two additional peer dependencies:

npm install realm-web node-fetch abort-controller