source/web/install.txt

.. _web-install:

===================
Install the Web SDK
===================

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 2
   :class: singlecol

Overview
--------

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

Before You Begin
----------------

Before you begin installation, you need to :ref:`create an App Services App <create-a-realm-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:

   - :ref:`React Native SDK <react-native-intro>`
   - :ref:`Node.js <node-intro>`
   - :ref:`Install Web SDK for Node.js <web-install-node>`

Install the Web SDK
-------------------

.. 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.

.. tabs::

   .. tab:: npm
      :tabid: npm

      .. code-block:: shell

         npm install realm-web

   .. tab:: yarn
      :tabid: yarn

      .. code-block:: shell

         yarn add realm-web

   .. tab:: CDN
      :tabid: CDN

      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:

      .. code-block:: html

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

      Or import a specific version:

      .. code-block:: html

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

.. _web-install-node:

Install for Node.js
-------------------

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

.. code-block:: shell

   npm install realm-web node-fetch abort-controller