feat(templates): add interactive AI based wiki to Boilerplate #11544 (#11545)

Author: ysmoradi

src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md

@@ -96,14 +96,15 @@ After applying changes, you **MUST** verify the integrity of the application.
 
 *   **Be Decisive**: Do not ask for permission to proceed or for a review of your plan. Directly state your plan and proceed with the implementation.
 *   **Execute Commands Individually**: **Never** chain CLI commands with `&&`. Execute each command in a separate step.
+*   **Getting started**: When a developer first interacts with you with a message like `Run getting started`, you **MUST** proactively follow `.github/prompts/getting-started.prompt.md`.
 
 ## 7. Critical Command Reference
 
 -   **Build the project**: Run `dotnet build` in Boilerplate.Server.Web project root directory.
 -   **Run the project**: Run `dotnet run` in Boilerplate.Server.Web project root directory.
 -   **Run tests**: Run `dotnet test` in Boilerplate.Tests project root directory.
 -   **Add new migrations**: Run `dotnet ef migrations add <MigrationName> --verbose` in Boilerplate.Server.Api project root directory.
--   **Generate Resx C# code**: Run `dotnet build -t:PrepareResources` in Boilerplate.Shared project root directory.
+-   **Generate Resx C# code**: Run `dotnet build -t:PrepareResources` in Boilerplate.Shared project root directory (It's automatically done during build).
 
 ## 8. Coding Conventions & Best Practices
 

src/Templates/Boilerplate/Bit.Boilerplate/.github/prompts/getting-started.prompt.md

@@ -4,7 +4,8 @@
     "DefaultLanguage": "en",
 
     "SupportedLanguages": [ "nl", "fa", "sv", "hi", "zh", "es", "fr", "ar", "de" ],
-    "SupportedLanguages__Comment": "Update MainActivity's DataPathPrefixes and CultureInfoManager's SupportedCultures as required.",
+    "SupportedLanguages__Comment__1": "Add or remove languages as needed. Use ISO language codes (e.g., 'es' for Spanish, 'fr' for French).",
+    "SupportedLanguages__Comment__2": "Update MainActivity's DataPathPrefixes and CultureInfoManager's SupportedCultures as required.",
 
     "ResxPaths": [ "/src/**/*.resx" ],
 

src/Templates/Boilerplate/Bit.Boilerplate/Bit.ResxTranslator.json

@@ -55,6 +55,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "prompts", "prompts", "{4A5D
 	ProjectSection(SolutionItems) = preProject
 		.github\prompts\resx.prompt.md = .github\prompts\resx.prompt.md
 		.github\prompts\bitify.prompt.md = .github\prompts\bitify.prompt.md
+		.github\prompts\getting-started.prompt.md = .github\prompts\getting-started.prompt.md
 		.github\prompts\scaffold.prompt.md = .github\prompts\scaffold.prompt.md
 	EndProjectSection
 EndProject

src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.sln

@@ -31,6 +31,7 @@
   <Folder Name="/.SolutionItems/.github/prompts/">
     <File Path=".github/prompts/resx.prompt.md" />
     <File Path=".github/prompts/bitify.prompt.md" />
+	<File Path=".github/prompts/getting-started.prompt.md" />
     <File Path=".github/prompts/scaffold.prompt.md" />
   </Folder>
 <!--#if (pipeline == "GitHub")-->

src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.slnx

@@ -83,7 +83,7 @@ public async Task<ProductDto> Create(ProductDto dto, CancellationToken cancellat
 
         await Validate(entityToAdd, cancellationToken);
 
-        //#if (database == "PostgreSQL" || database == "SqlServer" || signalR == true)
+        //#if (database == "PostgreSQL" || database == "SqlServer")
         //#if (IsInsideProjectTemplate == true)
         if (DbContext.Database.ProviderName!.EndsWith("PostgreSQL", StringComparison.InvariantCulture) ||
             DbContext.Database.ProviderName!.EndsWith("SqlServer", StringComparison.InvariantCulture))
@@ -116,7 +116,7 @@ public async Task<ProductDto> Update(ProductDto dto, CancellationToken cancellat
 
         await Validate(entityToUpdate, cancellationToken);
 
-        //#if (database == "PostgreSQL" || database == "SqlServer" || signalR == true)
+        //#if (database == "PostgreSQL" || database == "SqlServer")
         //#if (IsInsideProjectTemplate == true)
         if (DbContext.Database.ProviderName!.EndsWith("PostgreSQL", StringComparison.InvariantCulture) ||
             DbContext.Database.ProviderName!.EndsWith("SqlServer", StringComparison.InvariantCulture))

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Controllers/Products/ProductController.cs

@@ -97,32 +97,34 @@
                 @GetFileStorageCommand()
             </CodeBox>
 
-            @if (fileStorage.Value == "Local")
-            {
-                <div>
-                    The API project includes an Attachment Controller responsible for handling user images,
-                    including resizing and saving them in the WebP format using <a href="https://github.com/robinrodricks/FluentStorage" target="_blank">FluentStorage</a>
-                    <br />
-                    <br />
-                    Local option stores files on local hard drive.
-                </div>
-            }
-            @if (fileStorage.Value == "AzureBlobStorage")
-            {
-                <div>
-                    Download and install Azure blob storage emulator <a href="https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=npm%2Cblob-storage#install-azurite">here</a>.
-                </div>
-            }
-            @if (fileStorage.Value == "Other")
-            {
-                <div>
-                    Install and configure any of the <a href="https://www.nuget.org/profiles/hgupta" target="_blank">FluentStorage packages</a>.
-                    <br />
-                    <br />
-                    One noteable implementation is <a href="https://nuget.org/packages/FluentStorage.AWS" target="_blank">FluentStorage.AWS</a>, which supports Amazon S3.
-                    This allows you to use any file storage solution compatible with S3, such as DigitalOcean Spaces or MinIO.
-                </div>
-            }
+			@switch (fileStorage.Value)
+			{
+				case "Local":
+					<div>
+						The API project includes an Attachment Controller responsible for handling user images,
+						including resizing and saving them in the WebP format using <a href="https://github.com/robinrodricks/FluentStorage" target="_blank">FluentStorage</a>
+						<br />
+						<br />
+						Local option stores files on local hard drive.
+					</div>
+					break;
+				case "AzureBlobStorage":
+					<div>
+						Download and install Azure blob storage emulator <a href="https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=npm%2Cblob-storage#install-azurite">here</a>.
+					</div>
+					break;
+				case "S3":
+					<div>
+						Install and configure <a href="https://www.nuget.org/packages/FluentStorage.AWS" target="_blank">FluentStorage.AWS</a>, which supports Amazon S3.
+						This allows you to use any file storage solution compatible with S3, such as AWS, DigitalOcean Spaces, MinIO, Hetzner, Contabo etc.
+					</div>
+					break;
+				case "Other":
+					<div>
+						Install and configure any of the <a href="https://www.nuget.org/profiles/hgupta" target="_blank">FluentStorage packages</a>.
+					</div>
+					break;
+			}
         </BitGridItem>
 
         <BitGridItem Class="grid-item md">
@@ -171,9 +173,18 @@
             </CodeBox>
             <br />
             <BitText Typography="BitTypography.Body2">
-                Aspire helps you build, test, and deploy distributed applications with ease. Learn more at <a href="https://learn.microsoft.com/en-us/dotnet/aspire/" target="_blank">ASP.NET Core Aspire</a>.
+     Aspire helps you build, test, and deploy distributed applications with ease. Learn more at <a href="https://learn.microsoft.com/en-us/dotnet/aspire/" target="_blank">ASP.NET Core Aspire</a>.
+				<div class="video-container">
+						<iframe width="800" height="450"
+								allowfullscreen frameborder="0"
+								title="Aspire"
+								src="https://www.youtube.com/embed/-vd7quVCP1k?si=mf4GZrdqRYK6zZ25"
+								referrerpolicy="strict-origin-when-cross-origin"
+								allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"></iframe>
+				</div>
 				<CodeBox>dotnet tool install -g Aspire.Cli</CodeBox>
-            </BitText>
+				Aspire requires Docker Desktop to be installed and running. Download and install Docker Desktop from <a href="https://www.docker.com/products/docker-desktop/" target="_blank">here</a>.
+  </BitText>
         </BitGridItem>
 
         <BitGridItem Class="grid-item md" ColumnSpan="2">

src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates05CreateProjectPage.razor

@@ -101,4 +101,10 @@
             }
         }
     }
+
+    .video-container {
+        width: 100%;
+        display: flex;
+        justify-content: center;
+    }
 }

src/Websites/Platform/src/Bit.Websites.Platform.Client/Pages/Templates/Templates05CreateProjectPage.razor.scss

@@ -7,21 +7,22 @@
             Description="Run project of the project templates of the bit platform" />
 
 <div class="page-container">
-    <BitText Typography="BitTypography.H3" Gutter>Project Run Guidelines</BitText>
+    <BitText Typography="BitTypography.H3" Gutter>Project Run</BitText>
     <br />
     <br />
     <section class="section-card">
         <div class="section-card-txt">
-            The process for running the project varies based on the Api parameter set during project initiation:
+			The process for running the project varies based on the <b>Api</b> parameter set during project initiation:
             <br />
             <ul>
                 <li>
-                    <b>--api Integrated:</b> Simply run the Server.Web project (Running Server.Api is optional but not required).
+                    <b>--api Integrated (default):</b> Simply run the Server.Web project (Running Server.Api is optional but not required).
                 </li>
                 <li>
                     <b>--api Standalone:</b> Run both the Server.Api and Server.Web projects.
                 </li>
             </ul>
+			<b>Note:</b> You have to make sure that the connection strings section of the Server.Api is properly configured based on the database of your choice installation. However, if you've created the project with Aspire (which is enabled by default) and you've installed Docker Desktop, you can simply run the AppHost project. This will run all dependencies as Docker containers and provide you with an awesome handy dashboard as well.
         </div>
     </section>
     <br />
@@ -63,13 +64,6 @@
     "BlazorMode": "BlazorServer",
     "BlazorMode_Comment": "BlazorServer, BlazorWebAssembly and BlazorAuto."
 }</CodeBox>
-            <BitText Typography="BitTypography.H5" Gutter>Debugging in Blazor WebAssembly</BitText>
-            To debug the project in Blazor WebAssembly mode, change the Current value to BlazorWebAssembly for development. To fully
-            utilize debugging features, set the Launch profile to Server.Web-BlazorWebAssembly.
-            <br />
-            <div class="image-container">
-                <img class="image" src="images/templates/launch-options.webp" />
-            </div>
             <br />
             <BitText Typography="BitTypography.H5" Gutter>Running in Blazor WebAssembly Standalone Mode</BitText>
             To run the project in Blazor WebAssembly Standalone mode, run Client.Web in addition to server project.
@@ -221,4 +215,4 @@
     <br />
     <br />
 </div>
-<NavigationButtons Prev="Create project" PrevUrl="/templates/create-project" Next="Add new feature" NextUrl="/templates/add-new-feature" />
+<NavigationButtons Prev="Create project" PrevUrl="/templates/create-project" Next="Interactive Wiki" NextUrl="/templates/wiki" />