Skip to content

landing page, install, and quickstart #508

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

Merged
merged 2 commits into from
Oct 2, 2020
Merged
Show file tree
Hide file tree
Changes from all 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
62 changes: 38 additions & 24 deletions source/dotnet.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,31 @@ platforms to access data stored in local {+realms+} and
interact with {+backend+} services like Functions, MongoDB Data Access,
and authentication.

For more information about specific version support for .NET, UWP, and
Xamarin, see our :ref:`compatibility chart <dotnet-compatibility>`.
.. _dotnet_supported-platforms:

.. note::
Supported Platforms
-------------------
Realm supports the following platforms for developing Realm apps for iOS and
Android devices:

When building
for platforms with Xamarin, you can use either native UI or
`Xamarin Forms
<https://docs.microsoft.com/en-us/xamarin/xamarin-forms/>`__.
- Xamarin.iOS for iOS 9 or later, using native UI or Xamarin Forms
- Xamarin.Android for API level 16 or later, using native UI or Xamarin Forms
- Xamarin.Mac for macOS 10.11 or later, using nativeUI or Xamarin Forms
- .NET Framework 4.6.1 or later for Windows 8.1 or later
- Universal Windows Platform applications using .NET Standard 2.0 or later (Fall Creators Update)
- .NET Core 2.0 or later on the following:

- Ubuntu 16.04 or later
- Debian 8 or later
- RHEL 7.1 or later
- macOS 10.11 or later
- Windows 8.1 or later

You can use the following development environments to build Realm apps with
the .NET SDK:

- Visual Studio 2015 Update 2 or higher for Windows
- Visual Studio for Mac 7.0 or higher

Installation
------------
Expand All @@ -29,38 +45,36 @@ To learn how to add the {+service+} .NET SDK library as a dependency
to your application, see :ref:`Install Realm for .NET
<dotnet-install>`.

The Realm Data Model
--------------------
Realm Data Models
-----------------

You can store a wide variety of data within {+realms+} stored on your
device. With :term:`{+sync+}`, you can share updates to that data across
client devices and {+atlas+}.
device, and if you enable :term:`{+sync+}`, updates to that data are available
across multiple client devices. Data models are classes defined in your
code and in {+realm+} schemas.

For information about the structure of data you can store in {+realms+},
see :ref:`Realms <dotnet-realms>`, :ref:`Objects
<dotnet-realm-objects>`, and :ref:`Relationships
<dotnet-client-relationships>`.

To learn about the results returned from {+realm+} queries, see
:ref:`Collections <android-client-collections>`.

Work with Realm Database
------------------------
Work with a Realm Database
--------------------------

Once you have defined a data model for your application, you
need to be able to :ref:`write <dotnet-realm-database-writes>` and
:ref:`read <dotnet-realm-database-reads>` pieces of data to and from
Once you have defined the data model(s) for your application, you
can :ref:`write <dotnet-realm-database-writes>` and
:ref:`read <dotnet-realm-database-reads>` data to and from
your {+realm+}s.

To learn how to query for data in local {+realms+}, see
:ref:`Query Engine <dotnet-client-query-engine>`.

For advice on how to safely interact with {+client-database+} across
threads in an application, see :ref:`Threading
<dotnet-client-threading>`.
To learn about the results returned from {+realm+} queries, see
:ref:`Collections <dotnet-client-collections>`.

For information about how to react to changes in {+realm+} data, see
:ref:`Notifications <dotnet-client-notifications>`.
Mobile application development can be complicated by threading. To learn
how to work with {+backend-short+} across threads in your application,
see :ref:`Threading <dotnet-client-threading>`.

Work with MongoDB Realm
-----------------------
Expand Down
11 changes: 4 additions & 7 deletions source/dotnet/install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,23 @@ Overview
for the .NET, `UWP
<https://docs.microsoft.com/en-us/windows/uwp/get-started/>`__,
and `Xamarin <https://dotnet.microsoft.com/apps/xamarin>`__
ecosystems. When building for platforms with Xamarin, you
can use either native UI or `Xamarin Forms
<https://docs.microsoft.com/en-us/xamarin/xamarin-forms/>`__.
ecosystems.

For more information about specific version support for .NET, UWP, and
Xamarin, see our :ref:`compatibility chart <dotnet-compatibility>`.
Xamarin, see :ref:`Supported Platforms <dotnet_supported-platforms>`.

Prerequisites
-------------

Before getting started, ensure your development environment
meets the following prerequisites:
Before getting started, ensure you have installed Visual Studio:

- `Visual Studio <https://visualstudio.microsoft.com/downloads/>`__ 2015 Update 2 or later.
- `Visual Studio for Mac <https://visualstudio.microsoft.com/vs/mac/>`__ 7.0 or later.

Installation
------------

Follow these steps to add the {+service+}.NET SDK to your project.
Follow these steps to add the {+service+} .NET SDK to your project.

.. tabs::

Expand Down
28 changes: 5 additions & 23 deletions source/dotnet/quick-start.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,11 @@ integrated into your .NET app. Before you begin, ensure you have:
- :ref:`Created a {+app+} <create-a-realm-app>`
- :ref:`Enabled {+sync+} <enable-sync>`

Supported Platforms
-------------------
Realm supports the following platforms for developing Realm apps for iOS and
Android devices:

- Visual Studio 2019
- Xamarin.iOS for iOS 8 or later, using native UI or Xamarin Forms
- Xamarin.Android for API level 16 or later, using native UI or Xamarin Forms
- Xamarin.Mac for macOS 10.11 or later, using nativeUI or Xamarin Forms
- .NET Framework 4.6.1 or later for Windows 8.1 or later
- Universal Windows Platform applications using .NET Standard 2.0 or later (Fall Creators Update)
- .NET Core 2.0 or later on the following:

- Ubuntu 16.04 or later
- Debian 8 or later
- RHEL 7.1 or later
- macOS 10.11 or later
- Windows 8.1 or later

And supports the following development environments:

- Visual Studio 2015 Update 2 or higher for Windows
- Visual Studio for Mac 7.0 or higher
.. note::

See :ref:`Supported Platforms <dotnet_supported-platforms>` for the list of
platforms that Realm supports.


Import Realm
------------
Expand Down
2 changes: 1 addition & 1 deletion source/includes/steps-install-dotnet-vs-mac.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ content: |
:lightbox:

---
title: Add the Realm Weaver to FodyWeavers.xml
title: (Optional) Add the Realm Weaver to FodyWeavers.xml
ref: add-realm-weaver
content: |

Expand Down