docs: update docs

foxminchan · Jun 9, 2024 · cfb3989 · cfb3989
1 parent c67f887
commit cfb3989
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 0 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -22,6 +22,13 @@
         "nuke"
       ],
       "rollForward": false
+    },
+    "dotnet-stryker": {
+      "version": "4.0.6",
+      "commands": [
+        "dotnet-stryker"
+      ],
+      "rollForward": false
     }
   }
 }
diff --git a/README.md b/README.md
@@ -25,6 +25,7 @@ RookieShop is a .NET Core web application training project demonstrating Clean A
     - [Mac, Linux, \& Windows without Visual Studio](#mac-linux--windows-without-visual-studio)
   - [Setup tools and dependencies](#setup-tools-and-dependencies)
   - [Setup Stripe webhook](#setup-stripe-webhook)
+  - [User secrets example](#user-secrets-example)
   - [Running the application](#running-the-application)
 - [Testing](#testing)
 - [CI/CD](#cicd)
@@ -145,6 +146,26 @@ stripe login
 stripe listen --forward-to https://localhost:9000/api/stripe
 ```
 
+### User secrets example
+
+```json
+{
+  "Parameters": {
+    "SqlUser": "",
+    "SqlPassword": "",
+    "StripeApiKey": "",
+    "StripeWebhookSecret": "",
+    "EmailSecret": "",
+    "GoogleClientId": "",
+    "GoogleClientSecret": "",
+    "OpenAiKey": ""
+  },
+  "ConnectionStrings": {
+    "openai": "Key="
+  }
+}
+```
+
 ### Running the application
 
 > [!WARNING]

diff --git a/tests/RookieShop.FunctionalTests/RookieShop.FunctionalTests.csproj b/tests/RookieShop.FunctionalTests/RookieShop.FunctionalTests.csproj
@@ -17,6 +17,14 @@
 		<PackageReference Include="Ardalis.HttpClientTestExtensions" />
 	</ItemGroup>
 
+	<ItemGroup>
+		<Content Include="xunit.runner.json">
+			<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+			<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
+			<CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
+		</Content>
+	</ItemGroup>
+
 	<ItemGroup>
 		<ProjectReference Include="..\..\src\RookieShop.AppHost\RookieShop.AppHost.csproj" />
 	</ItemGroup>

diff --git a/tests/RookieShop.FunctionalTests/xunit.runner.json b/tests/RookieShop.FunctionalTests/xunit.runner.json
@@ -0,0 +1,6 @@
+{
+  "$schema": "https://xunit.net/schema/current/xunit.runner.schema.json",
+  "parallelizeAssembly": false,
+  "parallelizeTestCollections": true,
+  "shadowCopy": false
+}