Add links and text to the template and tutorial #161
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 Flutter SDK](https://www.mongodb.com/docs/realm/sdk/dotnet/) and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/). | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| You can follow along with the [Flutter Tutorial](https://www.mongodb.com/docs/atlas/app-services/tutorial/dotnet/) to see how to build, modify, and | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| run this template app. | ||||||
|
|
||||||
| ## Configuration | ||||||
|
|
||||||
| The App ID is located in `atlasConfig.json`: | ||||||
|
|
@@ -11,9 +16,14 @@ The App ID is located in `atlasConfig.json`: | |||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| 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 Flutter template app pre-configured for your new | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| app. | ||||||
|
|
||||||
| ### Cloning from GitHub | ||||||
|
|
||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) | ||||||
|
|
@@ -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 Flutter template app pre-configured for your new | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| app. | ||||||
|
|
||||||
| ### Cloning from GitHub | ||||||
|
|
||||||
| If you have cloned this repository from the GitHub | ||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,14 +1,26 @@ | ||||||
| # SwiftUI Template App | ||||||
|
|
||||||
| A todo list application built with the [SwiftUI SDK](https://www.mongodb.com/docs/realm/sdk/swift/) and [Atlas Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/). | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 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 | ||||||
|
|
||||||
| 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 Flutter template app pre-configured for your new | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| app. | ||||||
|
|
||||||
| ### Cloning from GitHub | ||||||
|
|
||||||
| If you have cloned this repository from the GitHub | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a nitpick for some of these, but presumably the people who are consuming this README will be doing so either from the artifact repo (https://github.com/mongodb/template-app-dart-flutter-todo) or as a download from the Atlas UI where
flutter_todois not part of the directory structure. So I think when we're providing the path, we should do it relative to where the README is located and not make any assumptions about the enclosing directory structure.(Also, if you take this suggestion, we should change it in ln 39 down below, too, I just can't leave a comment there since we're not modifying it here.)