Docs Menu

Create a Realm App with Realm UI

On this page

  • Overview
  • Prerequisites
  • Procedure

The following steps guide you through setting up a generic Realm app. The term "Realm app" refers to the central MongoDB Realm backend instance for your mobile or web application.

Before you begin, you must be logged in as a Project Owner in a MongoDB Atlas account. You can learn more about creating an Atlas account in the Atlas Getting Started documentation.

1

Go to the Project Dashboard where you want to create the Realm app. Select the Realm tab.

2

If you are creating your first Realm app in this Atlas project, you will be shown all the template apps available for you to start with, and an option to start without a template (Build your own App).

Modal showing all available template apps to start building from.

If you have already created at least one Realm app in this Atlas project, You can choose between two create buttons at the top right of the Realm tab

Dropdown menu showing all available template apps to start building from.
3

You will be shown a dialog where you can configure your Realm app, including the:

  • Application Name.

    Note
    App Name Limitations

    Application names must be between 1 and 32 characters and may only contain ASCII letters, numbers, underscores, and hyphens.

  • Linked Atlas cluster. If you do not have a cluster in this project, MongoDB Realm will create one. MongoDB Realm will automatically create a MongoDB service linked to this cluster with the name "mongodb-atlas".

    Note
    MongoDB Version 4.4 or Higher Required

    In order to use Realm Sync, your Atlas cluster must use MongoDB version 4.4 or higher. When setting up your cluster, select MongoDB 4.4 (or a higher version) from the dropdown menu under Additional Settings.

  • Deployment model.
  • Deployment region.

Click Create Realm Application.

Upon creation of your Realm app, you will be redirected to the MongoDB Realm console. Your Realm app is created with a MongoDB service named mongodb-atlas.

Give Feedback
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.