If you plan to develop with .NET Core or ASP.NET Core, you will need to download and install the latest .NET Core SDK. Additionally, if you do not already know the language and framework well, we recommend you first spend time working through some of the following tutorials from Microsoft:
NOTE: Many of the Steeltoe packages can also be used with .NET Framework and ASP.NET 4 based applications. You are not required to target .NET/ASP.NET Core when using Steeltoe.
When developing applications with Steeltoe, whether on .NET Core or .NET Framework, you need to pull the Steeltoe NuGet packages into your application.
To use the latest releases of Steeltoe, you can subscribe to any one of the following feeds, depending on your needs:
The following example shows a NuGet.config file that you can edit and use when developing applications with Steeltoe:
<?xml version="1.0" encoding="utf-8"?> <configuration> <packageSources> <add key="SteeltoeMaster" value="https://www.myget.org/F/steeltoemaster/api/v3/index.json" /> <add key="SteeltoeDev" value="https://www.myget.org/F/steeltoedev/api/v3/index.json" /> <add key="NuGet" value="https://api.nuget.org/v3/index.json" /> </packageSources> </configuration>
NOTE: If you only want to use release or pre-release (RC) versions of Steeltoe, you need not make any changes to your NuGet.config file, as those are served from
For many of the Steeltoe components, we provide Quick Start samples and a guide that describes how to quickly get a sample application up and running by using a particular Steeltoe component. A detailed breakdown of the sample code, describing how Steeltoe has been integrated into the app, is provided.
In many cases, these guides provide two ways of exercising the applications: one that describes how to create and run the application locally on your development machine and a second that describes running the application on Cloud Foundry.
For the Quick Starts in which we run the application locally, Java is required to run instances of some of the servers (such as Spring Cloud Config Server, Netflix Eureka Server, and others) on your machine. If you do not have Java available on your machine, you may want to install that now.
For the Quick Starts running on Cloud Foundry, you need access to a Cloud Foundry environment that has the appropriate services (such as Spring Cloud Config Server, Netflix Eureka Server, and others) installed. One option is to run PCF Dev, the local developer version of Pivotal Cloud Foundry on your development machine. PCF Dev depends on Virtual Box, so, depending on your desktop operating system and configuration, you may not be able to use it.
Alternatively, you can sign up for a free trial account of Pivotal Web Services, the hosted multi-tenant edition of Pivotal Cloud Foundry. Note that, if you want to work solely with .NET framework applications that target the Windows operating system, you likely need access to a corporate Cloud Foundry environment, as neither of the above options currently support deploying Windows apps.
Regardless of which Cloud Foundry option you choose, in order to work with Cloud Foundry, you need to install the Cloud Foundry Command Line Interface (CLI).
Finally, for all of the Quick Starts, you need to install the GIT command line tools so that you can fetch the Quick Start sample code and work with it on your computer.Create a pull request or raise an issue on the source for this page in GitHub