diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index f21b7dc13e5c6..067e1794ea391 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -4225,6 +4225,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Add a .NET Project", + "path": "/showcase/example-repos/add-dotnet", + "id": "add-dotnet", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Add a Nuxt Project", "path": "/showcase/example-repos/add-nuxt", @@ -4414,6 +4422,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Add a .NET Project", + "path": "/showcase/example-repos/add-dotnet", + "id": "add-dotnet", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Add a Nuxt Project", "path": "/showcase/example-repos/add-nuxt", @@ -4561,6 +4577,14 @@ "children": [], "disableCollapsible": false }, + { + "name": "Add a .NET Project", + "path": "/showcase/example-repos/add-dotnet", + "id": "add-dotnet", + "isExternal": false, + "children": [], + "disableCollapsible": false + }, { "name": "Add a Nuxt Project", "path": "/showcase/example-repos/add-nuxt", diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json index 949f9812669b8..fdf4aba5c0011 100644 --- a/docs/generated/manifests/nx.json +++ b/docs/generated/manifests/nx.json @@ -5267,6 +5267,16 @@ "path": "/showcase/example-repos/add-rust", "tags": [] }, + { + "id": "add-dotnet", + "name": "Add a .NET Project", + "description": "Add a .NET project to your repo", + "file": "shared/recipes/add-stack/add-dotnet", + "itemList": [], + "isExternal": false, + "path": "/showcase/example-repos/add-dotnet", + "tags": [] + }, { "id": "add-nuxt", "name": "Add a Nuxt Project", @@ -5504,6 +5514,16 @@ "path": "/showcase/example-repos/add-rust", "tags": [] }, + { + "id": "add-dotnet", + "name": "Add a .NET Project", + "description": "Add a .NET project to your repo", + "file": "shared/recipes/add-stack/add-dotnet", + "itemList": [], + "isExternal": false, + "path": "/showcase/example-repos/add-dotnet", + "tags": [] + }, { "id": "add-nuxt", "name": "Add a Nuxt Project", @@ -5689,6 +5709,16 @@ "path": "/showcase/example-repos/add-rust", "tags": [] }, + "/showcase/example-repos/add-dotnet": { + "id": "add-dotnet", + "name": "Add a .NET Project", + "description": "Add a .NET project to your repo", + "file": "shared/recipes/add-stack/add-dotnet", + "itemList": [], + "isExternal": false, + "path": "/showcase/example-repos/add-dotnet", + "tags": [] + }, "/showcase/example-repos/add-nuxt": { "id": "add-nuxt", "name": "Add a Nuxt Project", diff --git a/docs/map.json b/docs/map.json index 918723c59d76b..0a8cc114d8a70 100644 --- a/docs/map.json +++ b/docs/map.json @@ -1229,6 +1229,12 @@ "description": "Add a Rust project to your repo", "file": "shared/recipes/add-stack/add-rust" }, + { + "name": "Add a .NET Project", + "id": "add-dotnet", + "description": "Add a .NET project to your repo", + "file": "shared/recipes/add-stack/add-dotnet" + }, { "name": "Add a Nuxt Project", "id": "add-nuxt", diff --git a/docs/shared/recipes/add-stack/add-dotnet.md b/docs/shared/recipes/add-stack/add-dotnet.md new file mode 100644 index 0000000000000..b59f05e87109f --- /dev/null +++ b/docs/shared/recipes/add-stack/add-dotnet.md @@ -0,0 +1,165 @@ +# Add a New .NET Project + +**Supported Features** + +Because we are using an Nx plugin for .NET, all the features of Nx are available. + +{% pill url="/core-features/run-tasks" %}✅ Run Tasks{% /pill %} +{% pill url="/core-features/cache-task-results" %}✅ Cache Task Results{% /pill %} +{% pill url="/core-features/remote-cache" %}✅ Share Your Cache{% /pill %} +{% pill url="/core-features/explore-graph" %}✅ Explore the Graph{% /pill %} +{% pill url="/core-features/distribute-task-execution" %}✅ Distribute Task Execution{% /pill %} +{% pill url="/core-features/integrate-with-editors" %}✅ Integrate with Editors{% /pill %} +{% pill url="/core-features/automate-updating-dependencies" %}✅ Automate Updating Nx{% /pill %} +{% pill url="/core-features/enforce-module-boundaries" %}✅ Enforce Module Boundaries{% /pill %} +{% pill url="/core-features/plugin-features/use-task-executors" %}✅ Use Task Executors{% /pill %} +{% pill url="/core-features/plugin-features/use-code-generators" %}✅ Use Code Generators{% /pill %} +{% pill url="/core-features/automate-updating-dependencies" %}✅ Automate Updating Framework Dependencies{% /pill %} + +## Install the @nx-dotnet/core Plugin + +{% callout type="warning" title="Have .NET already installed?" %} +Make sure you have .NET installed on your machine. Consult the [.NET docs for more details](https://dotnet.microsoft.com/learn/dotnet/hello-world-tutorial/install) +{% /callout %} + +{% tabs %} +{%tab label="npm"%} + +```shell +npm i --save-dev @nx-dotnet/core +``` + +{% /tab %} +{%tab label="yarn"%} + +```shell +yarn add --dev @nx-dotnet/core +``` + +{% /tab %} +{% /tabs %} + +## Set up your workspace + +Use the `init` generator to scaffold out some root level configuration files. + +```shell +nx g @nx-dotnet/core:init +``` + +This generates the following files: + +```json {% fileName=".config/dotnet-tools.json" %} +{ + "version": 1, + "isRoot": true, + "tools": {} +} +``` + +```json {% fileName=".nx-dotnet.rc.json" %} +{ + "nugetPackages": {} +} +``` + +```xml {% fileName="Directory.Build.props" %} + + + + + $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)')) + $([MSBuild]::MakeRelative($(RepoRoot), $(MSBuildProjectDirectory))) + $(RepoRoot)dist/$(ProjectRelativePath) + $(BaseOutputPath) + $(RepoRoot)dist/intermediates/$(ProjectRelativePath)/obj + $(BaseIntermediateOutputPath) + true + + + false + + +``` + +```xml {% fileName="Directory.Build.targets" %} + + + + $([MSBuild]::MakeRelative($(RepoRoot), $(MSBuildProjectDirectory))) + $([MSBuild]::MakeRelative($(MSBuildProjectDirectory), $(RepoRoot))) + + + + + +``` + +## Create an Application + +Use the `app` generator to create a new .NET app. For this demo, use the `nx` path naming convention and the `web-api` project template. + +```shell +nx g @nx-dotnet/core:app my-api --test-template nunit --language C# +``` + +Serve the API by running + +```shell +nx serve my-api +``` + +## Create a Library + +To create a new library, run the library generator. Use the `classlib` template. + +```shell +nx g @nx-dotnet/core:lib dotnet-lib +``` + +We also want to add a project reference from `my-api` to `dotnet-lib` using the `project-reference` generator: + +```shell +nx generate @nx-dotnet/core:project-reference --project=my-api --reference=dotnet-lib +``` + +Now we can move the `WeatherForecast.cs` file out of the `my-api` folder and into the `dotnet-lib` folder. We also need to update the namespace for the file like this: + +```c# {% fileName="libs/dotnet-lib/WeatherForecast.cs" %} +namespace DotnetLib; + +public class WeatherForecast +{ + public DateOnly Date { get; set; } + + public int TemperatureC { get; set; } + + public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); + + public string? Summary { get; set; } +} +``` + +Now use the `dotnet-lib` version of `WeatherForecast` in `my-api`: + +```c# {% fileName="apps/my-api/Controllers/WeatherForecastController.cs" %} +using Microsoft.AspNetCore.Mvc; +using DotnetLib; + +namespace MyApi.Controllers; + +// the rest of the file is unchanged +``` + +Now when you serve your api it will use the class from the library. + +## More Documentation + +- [nx-dotnet](https://www.nx-dotnet.com/) +- [.NET](https://dotnet.microsoft.com/en-us/) diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index bd12d11dfc8a6..d506d70dd045a 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -207,6 +207,7 @@ - [Add a Solid Project](/showcase/example-repos/add-solid) - [Add a Qwik Project](/showcase/example-repos/add-qwik) - [Add a Rust Project](/showcase/example-repos/add-rust) + - [Add a .NET Project](/showcase/example-repos/add-dotnet) - [Add a Nuxt Project](/showcase/example-repos/add-nuxt) - [Add an Astro Project](/showcase/example-repos/add-astro) - [Add a Vue Project](/showcase/example-repos/add-vue)