Skip to content

Commit

Permalink
Merge pull request #76 from Esri/dev
Browse files Browse the repository at this point in the history
Update master for v1.1.0
  • Loading branch information
nCastle1 authored Dec 19, 2019
2 parents a50ce0f + 2f19a09 commit 67fa104
Show file tree
Hide file tree
Showing 199 changed files with 8,865 additions and 2,173 deletions.
73 changes: 44 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,52 @@
# Data Collection .NET

[Data Collection for .NET](https://developers.arcgis.com/example-apps/data-collection-dotnet/) shows how a robust application can be built around the ArcGIS Platform using the ArcGIS Runtime SDK for .NET and WPF. It demonstrates best practices around some simple but key functionality of the ArcGIS Runtime. Using your organization's web maps, you can use Data Collection as is, or extend it to meet your specific needs.
Data Collection for .NET shows how a robust application can be built with the ArcGIS Platform using the ArcGIS Runtime SDK for .NET, WPF, and UWP. It demonstrates best practices around some simple but key functionality of the ArcGIS Runtime. Using your organization's web maps, you can use Data Collection as-is, or extend it to meet your specific needs.

![Screenshot of the data collection app for WPF, showing the Portland Tree Survey dataset with an identified feature popup](Documentation/img/anatomy-identified-feature.png)

## Features
* Taking your web map and data offline
* Editing your data both offline and online
* Synchronizing offline edits
* Viewing and editing your data with Popups
* Working with Features, Popups, and PopupManagers
* Editing and querying Feature Tables
* Working with related records
* Identifying map features
* Portal authentication with OAuth
* Using the World Geocoder service
* Using Popup configuration to drive app behavior

## Best Practices

* Take your web map and data offline
* Edit your data both offline and online
* Synchronize offline edits
* View and edit your data with Popups
* Work with Features, Popups, Attachments, and PopupManager
* Edit and query Feature Tables
* Work with related records
* Identify map features
* Authenticate with Portal using OAuth
* Use the World Geocoder service
* Use Popup configuration to drive app behavior

## Best practices

The project also demonstrates some patterns for building real-world apps around the ArcGIS Runtime SDK.

* Map-centric UI design
* ArcGIS asynchronous service pattern
* Cross-platform ready application design
* Cross-platform application design
* Model-View-ViewModel pattern

## Get Started
You will need [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) and the [ArcGIS Runtime SDK](https://developers.arcgis.com/downloads/apis-and-sdks?product=net) (v100.5 or later) installed locally.
## Get started

You will need [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) or later. You can use the [ArcGIS Runtime SDK](https://developers.arcgis.com/downloads/apis-and-sdks?product=net) extension (v100.7 or later) installed locally or install the Runtime packages from Nuget.org.

### Fork the repo
**Fork** the [Data Collection](https://github.com/Esri/data-collection-dotnet/fork) repo

**Fork** the [Data Collection](https://github.com/Esri/data-collection-dotnet/fork) repo.

### Clone the repo

Once you have forked the repo, you can make a clone and open `DataCollection.sln` in Visual Studio.

#### Command line Git

1. [Clone Data Collection](https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork)
2. `cd` into into the cloned repository's directory
3. Make your changes and create a [pull request](https://help.github.com/articles/creating-a-pull-request)

### Configuring a Remote for a Fork

If you make changes in the fork and would like to [sync](https://help.github.com/articles/syncing-a-fork/) those changes with the upstream repository, you must first [configure the remote](https://help.github.com/articles/configuring-a-remote-for-a-fork/). This will be required when you have created local branches and would like to make a [pull request](https://help.github.com/articles/creating-a-pull-request) to your upstream branch.

1. In the Terminal (for Mac users) or command prompt (for Windows and Linux users) type `git remote -v` to list the current configured remote repo for your fork.
Expand All @@ -52,21 +61,21 @@ If there are changes made in the original repository, you can sync the fork to k

### Configure the app

The app can be run as is, but it's recommended you do some configuration to set up OAuth to be relevant to your users. At minimum, the app should not be deployed without these changes:
The app can be run as-is, but it's recommended you do some configuration to set up OAuth to be relevant to your users. At minimum, the app should not be deployed without these changes:

1. Register an ArcGIS Portal Application.
2. Configure Data Collection project to reference that application.
3. License the app to remove the Developer Mode watermark and for deployment.

#### 1. Register an Application
#### 1. Register an application

For OAuth configuration, create a new Application in your ArcGIS Portal to obtain a `Client ID` and configure a `Redirect URL`. The **Client ID** configures the ArcGIS Runtime to show your users, during the login process, that the application was built by you and can be trusted. The **Redirect URL** configures the OAuth process to then return to your app once authentication is complete.

1. Log in to [https://developers.arcgis.com](https://developers.arcgis.com) with either your ArcGIS Organizational Account or an ArcGIS Developer Account.
2. Register a new Application. ![Register ArcGIS Application](https://user-images.githubusercontent.com/20545379/48228207-6885e500-e359-11e8-99dd-fe528dc50875.png)
3. In the Authentication tab, note the **Client ID** and add a **Redirect URL**, e.g. `data-collection://auth`. We will use this URL in the **Configuring the project** section below. ![Configure ArcGIS Application](https://user-images.githubusercontent.com/20545379/48228212-6de32f80-e359-11e8-9404-aa50858f7cb3.png)

#### 2. Configuring the project
#### 2. Configure the project

1. Open the solution in Visual Studio and browse to the file named `Configuration.xml` located in the `Properties` directory of the `DataCollection.Shared` project.
2. _(Optionally)_ configure the `WebmapURL` to match your organization's webmap.
Expand All @@ -75,24 +84,28 @@ For OAuth configuration, create a new Application in your ArcGIS Portal to obtai
4. Configure the Client ID.
* Set the `ClientID` property with the **Client ID** generated when you registered your application (see section above).

## Learn More
Learn more about Esri Example Apps [here](https://developers.arcgis.com/example-apps).
## Learn more

Learn more about Esri Open Source Apps [here](https://developers.arcgis.com/example-apps).

## Requirements
* [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/)

* [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) or later
* [ArcGIS Runtime SDK for .NET](https://developers.arcgis.com/downloads/apis-and-sdks?product=net)
* To edit records or take a web map offline you will need an ArcGIS Online Organizational account, an ArcGIS Online Developer account or an ArcGIS Online account authenticated using a social login.
* To consume your own web map you will need an ArcGIS Online Organizational account.

## Contributing
## Contribute

Anyone and everyone is welcome to [contribute](CONTRIBUTING.md). We do accept pull requests.

1. Get involved
2. Report issues
3. Contribute code
4. Improve documentation

## Licensing
## License

Copyright 2019 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Expand All @@ -105,7 +118,9 @@ A copy of the license is available in the repository's [LICENSE](LICENSE) file.

For information about licensing your deployed app, see [License your app](https://developers.arcgis.com/net/latest/wpf/guide/license-your-app.htm).

### 3rd Party Component Licensing
Some great open source components are available out there for .NET developers. The following have been used in this project, with much gratitude to their authors.
### 3rd-party component licensing

This project uses the following 3rd-party components:

* [Extended WPF Toolkit by XCeed](https://github.com/xceedsoftware/wpftoolkit) is licensed under the [Microsoft Public License] (https://github.com/xceedsoftware/wpftoolkit/blob/master/license.md)
* [Extended WPF Toolkit by XCeed](https://github.com/xceedsoftware/wpftoolkit) is licensed under the [Microsoft Public License](https://github.com/xceedsoftware/wpftoolkit/blob/master/license.md)
* [Humanizer](https://github.com/Humanizr/Humanizer) - [MIT License](https://github.com/Humanizr/Humanizer/blob/master/LICENSE)
15 changes: 14 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# Release notes

## 1.1.0

This is the third release of the Data Collection app for .NET, built on ArcGIS Runtime 100.7.

New features at 1.1.0 include:

* Upgraded to the latest 100.7 ArcGIS Runtime
* Support for viewing, adding, and deleting feature attachments
* UWP implementation of the app, built on the same shared foundation
* Bug fixes and performance improvements

## 1.0.1

- Comprehensive [app documentation](/docs/index.md) from the ArcGIS for Developers site.
New features at 1.0.1 include:

* Comprehensive [app documentation](/docs/index.md) from the ArcGIS for Developers site.

## 1.0.0

Expand Down
Binary file added docs/images/anatomy-app-context-drawer-uwp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-app-context-drawer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/anatomy-identified-feature-uwp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-identified-feature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/anatomy-map-view-uwp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-map-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/anatomy-new-feature-uwp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-new-feature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/anatomy-offline-extent-uwp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-offline-extent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/anatomy-popup-edit-uwp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-popup-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-popup-view-relationships.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/anatomy-popup-view-uwp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/anatomy-popup-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/data-model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/featured-img.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 67fa104

Please sign in to comment.