Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links and text to the template and tutorial #161

Merged
merged 3 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions sync-todo/v2/client/flutter/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
# Realm Flutter Todo

A todo list application built with the [Realm Flutter SDK](https://www.mongodb.com/docs/realm/sdk/flutter/)
and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/).
A todo list application built with the [Realm Flutter SDK](https://www.mongodb.com/docs/realm/sdk/flutter/) and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/).

You can follow along with the [Flutter Tutorial](https://www.mongodb.com/docs/atlas/app-services/tutorial/flutter/) to see how to build, modify, and
run this template app.

## Configuration

Ensure `flutter_todo/assets/config/atlasConfig.json` exists and contains the following properties:
For this template app to work, you must ensure that `/assets/config/atlasConfig.json` exists and contains the following properties:

- **appId:** your Atlas App Services App ID.
- **baseUrl:** the App Services backend URL. This should be https://realm.mongodb.com in most cases.

### Using the Atlas App Services UI

The easiest way to use this template app is to log on to [Atlas App Services](https://realm.mongodb.com/) 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 Flutter template app pre-configured for your new
app.

### Cloning from GitHub

If you have cloned this repository from the GitHub
Expand All @@ -27,7 +36,7 @@ to: [Find Your Project or App Id](https://www.mongodb.com/docs/atlas/app-service

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 `flutter_todo/assets/config/atlasConfig.json`
in this client's `appId` field in `/assets/config/atlasConfig.json`
with your App Services App ID. For help finding this ID, refer to:
[Find Your Project or App Id](https://www.mongodb.com/docs/atlas/app-services/reference/find-your-project-or-app-id/)

Expand Down
18 changes: 15 additions & 3 deletions sync-todo/v2/client/kotlin-sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Realm Kotlin SDK Template App

A todo list application built with the [Realm Kotlin SDK](https://www.mongodb.com/docs/realm/sdk/kotlin/) and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/).

You can follow along with the [Kotlin Tutorial](https://www.mongodb.com/docs/atlas/app-services/tutorial/kotlin/) to see how to build, modify, and
run this template app.

## Configuration

Ensure `app/src/main/res/values/atlasConfig.xml` exists and contains the following properties:
For this template app to work, you must ensure that `/app/src/main/res/values/atlasConfig.xml` exists and contains the following properties:

- **appId:** your Atlas App Services App ID.
- **baseUrl:** the App Services backend URL. This should be https://realm.mongodb.com in most cases.

### Using the Atlas App Services UI

- **realm_app_id:** your Atlas App Services App ID.
- **realm_base_url** the App Services backend URL. This should be https://realm.mongodb.com in most cases.
The easiest way to use this template app is to log on to [Atlas App Services](https://realm.mongodb.com/) 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 Kotlin template app pre-configured for your new
MongoCaleb marked this conversation as resolved.
Show resolved Hide resolved
app.

### Cloning from GitHub

Expand Down
16 changes: 13 additions & 3 deletions sync-todo/v2/client/maui/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Maui C# Template App

A todo list application built with the [.NET SDK](https://www.mongodb.com/docs/realm/sdk/dotnet/) and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/).

You can follow along with the [MAUI Tutorial](https://www.mongodb.com/docs/atlas/app-services/tutorial/dotnet/) to see how to build, modify, and
run this template app.

## Configuration

The App ID is located in `atlasConfig.json`:
Expand All @@ -11,9 +16,14 @@ The App ID is located in `atlasConfig.json`:
}
```

Change the value of `appId` value with your App Services App ID. For help
finding this ID, refer to:
[Find Your Project or App Id](https://www.mongodb.com/docs/atlas/app-services/reference/find-your-project-or-app-id/)
You will need to change the value of `appId` value with your App Services App ID. For help finding this ID, refer to: [Find Your Project or App Id](https://www.mongodb.com/docs/atlas/app-services/reference/find-your-project-or-app-id/)

### Using the Atlas App Services UI

The easiest way to use this template app is to log on to [Atlas App Services](https://realm.mongodb.com/) 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 MAUI template app pre-configured for your new
app.

### Cloning from GitHub

Expand Down
12 changes: 12 additions & 0 deletions sync-todo/v2/client/react-native/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# React Native Template App

A todo list application built with the [React Native SDK](https://www.mongodb.com/docs/realm/sdk/react-native/) and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/).

You can follow along with the [React Native Tutorial](https://www.mongodb.com/docs/atlas/app-services/tutorial/react-native/) to see how to build, modify, and
run this template app.

## Prerequisites

- Make sure your system is setup to run a React Native application by following the [setup guide](https://reactnative.dev/docs/environment-setup)
Expand All @@ -19,6 +24,13 @@ Ensure `atlasConfig.json` exists and contains the following properties:
- **appId:** your Atlas App Services App ID.
- **baseUrl:** the App Services backend URL. This should be https://realm.mongodb.com in most cases.

### Using the Atlas App Services UI

The easiest way to use this template app is to log on to [Atlas App Services](https://realm.mongodb.com/) 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
Expand Down
14 changes: 13 additions & 1 deletion sync-todo/v2/client/swiftui/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
# SwiftUI Template App

A todo list application built with the [Realm Swift SDK](https://www.mongodb.com/docs/realm/sdk/swift/) and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/).

You can follow along with the [SwiftUI Tutorial](https://www.mongodb.com/docs/atlas/app-services/tutorial/swiftui/) to see how to build, modify, and
run this template app.

This project uses Swift Package Manager (SPM) to load dependencies.

## Configuration

Ensure `App/atlasConfig.plist` exists and contains the following properties:
For this template app to work, you must ensure that `App/atlasConfig.plist` exists and contains the following properties:

- **appId:** your Atlas App Services App ID.
- **baseUrl:** the App Services backend URL. This should be https://realm.mongodb.com in most cases.

### Using the Atlas App Services UI

The easiest way to use this template app is to log on to [Atlas App Services](https://realm.mongodb.com/) 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 SwiftUI template app pre-configured for your new
app.

### Cloning from GitHub

If you have cloned this repository from the GitHub
Expand Down
Loading