Add links and text to the template and tutorial #161
Merged
Conversation
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
dacharyc
reviewed
Aug 25, 2023
|
|
||
| ## Configuration | ||
|
|
||
| Ensure `flutter_todo/assets/config/atlasConfig.json` exists and contains the following properties: | ||
| For this template app to work, you must ensure that `flutter_todo/assets/config/atlasConfig.json` exists and contains the following properties: |
There was a problem hiding this comment.
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_todo is 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.
Suggested change
| For this template app to work, you must ensure that `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: |
(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.)
| ## 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 `kotlin-sdk/app/src/main/res/values/atlasConfig.xml` exists and contains the following properties: |
There was a problem hiding this comment.
Same note as above re: the directory structure.
Suggested change
| For this template app to work, you must ensure that `kotlin-sdk/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: |
|
|
||
| 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
| created, you can download this Flutter template app pre-configured for your new | |
| created, you can download this React Native template app pre-configured for your new |
sync-todo/v2/client/maui/README.md
Outdated
|
|
||
| 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
| created, you can download this Flutter template app pre-configured for your new | |
| created, you can download this Maui template app pre-configured for your new |
| - **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 Flutter template app pre-configured for your new |
There was a problem hiding this comment.
Suggested change
| created, you can download this Flutter template app pre-configured for your new | |
| created, you can download this Kotlin template app pre-configured for your new |
sync-todo/v2/client/maui/README.md
Outdated
| @@ -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
| 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/). | |
| 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/). |
sync-todo/v2/client/maui/README.md
Outdated
| @@ -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/). | |||
|
|
|||
| 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
| 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 | |
| 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 |
| @@ -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
| 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/). | |
| 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/). |
|
|
||
| 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
| created, you can download this Flutter template app pre-configured for your new | |
| created, you can download this SwiftUI template app pre-configured for your new |
dacharyc
approved these changes
Aug 25, 2023
Co-authored-by: Dachary <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Jira
https://jira.mongodb.org/browse/DOCSP-32473