Atlas Device SDK for the Web

Realm is now Atlas Device SDK – Learn More

GraphQL is deprecated. Learn More.

The Atlas Device SDK for the Web lets browser-based applications access data stored in Atlas and interact with App Services services like Functions and authentication. The Web SDK supports both JavaScript and TypeScript.

Web apps built with the SDK can query Atlas using the following methods:

The standard MongoDB query API with the MongoDB client
Atlas Device Sync

Unlike the other SDKs, the Web SDK only supports creating an in-memory database, not one persisted to disk.

Learning Paths

Get Started with the Web SDK

Quick Start

Minimal-explanation code examples of how to work with the Web SDK.

See Code Examples

Working Example App

Learn by example through dissecting a working React app that uses the Web SDK and Atlas GraphQL API.

Explore an Example App

What You Can Do

Develop Apps with the SDK

Use the Web SDK with Atlas App Services to query MongoDB directly, query a GraphQL API, invoke serverless functions, manage user authentication, and more.

Configure Atlas App Services

You can use the Web SDK to query MongoDB Atlas data directly from the browser. Perform CRUD, aggregation, and listen for database changes.

First, you must create an App Services App, set up database rules, and enable user authentication.

Connect to an Atlas App Services App

To access your App Services App from the browser, initialize the App client.

Authenticate a User

To authenticate a user, usee one of the App Services authentication providers. App Services includes custom JWT, Facebook, Google, Apple, anonymous, and built-in email/password authentication providers.

Query MongoDB

Query MongoDB directly from the browser using your authenticated user. The user can only access data that they're authorized to.

For more information, refer to Query MongoDB.

Configure Atlas GraphQL API

The Atlas GraphQL API automatically generates a hosted endpoint with GraphQL queries and mutations based on JSON schemas for the documents in your database.

Configure App Services Authentication with data access rules to control which users have access to what data. Configure the GraphQL API in Atlas App Services.

Connect to Atlas App Services

To access your App Services App from the browser, initialize the App client.

Authenticate a User

Query the GraphQL API

Query the GraphQL API using a GraphQL client from the browser. Authenticate requests with user credentials.

Learn how to query the GraphQL API with the Apollo Client.

Call Serverless Functions

You can call serverless Functions from your client application that run in an App Services backend.

Authenticate Users

Authenticate users with built-in and third-party authentication providers. Use the authenticated user to access App Services.

Essential Documentation

Example Projects

Explore engineering and expert-provided example projects to learn best practices and common development patterns using the Web SDK. Check out the Example Projects page for more sample apps.