...
.Net Core SDK
.Net IDE of choice
Access to the SkySync SDK packages
Getting Started
All of our tutorials will begin from the command-line. This is the most portable way to work with the dotnet CLI and makes no assumptions about your operating system or IDE of choice. In order to make it super easy to create custom SkySync Platform extensions, we deliver a custom dotnet new template package. Your IDE should have details available on how to leverage custom dotnet new templates from within the IDE if you prefer to stay in there. If you are unfamiliar with custom templates within the dotnet CLI, you can review here and here for more information. Our first step is to install the SkySync dotnet new template package.
...
This will create a solution that contains the two new projects that we created in the previous step.
...
Developing our Extension
Build
To build your extension, you can run the following:
| Code Block | ||
|---|---|---|
| ||
cd MyCustomExtension dotnet build |
...
This will build your extension in the Debug configuration as well as copy the extension into the appropriate directory on your machine for SkySync to pick it up if you have a local copy that you can use to test live within the product.
Test
It is recommended that as you are developing your extension that you create a suite of automated tests that can exercise the functionality of your extension. Depending on the type of extension that you are developing, SkySync has a number of test utilities that can be leveraged to assist in creating your automated tests. Those are discussed in other guides that dive deeper into the more specific types of extensions that SkySync supports. However, once you have written your automated tests then running is as simple as running the following:
| Code Block | ||
|---|---|---|
| ||
cd MyCustomExtension\test\MyCustomExtension.Tests dotnet test |
...
Once your extension is fully developed, then you are ready to package the extension for deployment. This can be accomplished by running the following on your extension project.
| Code Block | ||
|---|---|---|
| ||
cd MyCustomExtension\src\MyCustomExtension dotnet pack --configuration Release |
...