Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 3.62 KB

README.md

File metadata and controls

73 lines (52 loc) · 3.62 KB
Raw

React Native Template App

A todo list application built with the React Native SDK and Atlas Device Sync.

You can follow along with the React Native Tutorial to see how to build, modify, and run this template app.

Warning

As of September 2024, Atlas Device SDKs are deprecated. Atlas Device SDKs will reach end-of-life and will no longer be maintained by MongoDB on September 30, 2025.

The template app in this repository should only be used as a reference for the on-device database and not to create a new app based on Device Sync. Refer to the deprecation page for details.

Prerequisites

  • Make sure your system is setup to run a React Native application by following the setup guide

  • Set up an Atlas account and deploy a cluster

  • Set up an application in App Services.

    • You can use the realm-cli to set up the backend and download a copy of this template:

      realm-cli apps create -n "<App Name>" --template "react-native.todo.flex"

Configuration

Ensure atlasConfig.json exists and contains the following properties:

Using the Atlas App Services UI

The easiest way to use this template app is to log on to Atlas App Services and click the Create App From Template button. Choose Real Time Sync, and then follow the prompts. While the backend app is being created, you can download this React Native template app pre-configured for your new app.

Cloning from GitHub

If you have cloned this repository from the GitHub mongodb/template-app-react-native-todo repository, you must create a separate App Services App with Device Sync enabled to use this client. You can find information about how to do this in the Atlas App Services documentation page: Template Apps -> Create a Template App

Once you have created the App Services App, replace any value in this client's appId field with your App Services App ID. For help finding this ID, refer to: Find Your Project or App Id

Download the Client as a Zip File

If you have downloaded this client as a .zip file from the Atlas App Services UI, it does not contain the App Services App ID. You must replace any value in this client's appId field in atlasConfig.json with your App Services App ID. For help finding this ID, refer to: Find Your Project or App Id

How to Run the Application:

  • Make sure you are in this directory
  • npm install
  • npx pod-install if on Mac
  • npm run ios (or npm run android, if you have an emulator running. Note: If you have not set up your development environment for running react-native android apps, see: https://reactnative.dev/docs/environment-setup)

Issues

Please report issues with the template at https://github.com/mongodb-university/realm-template-apps/issues/new