updated in the nuget packaging

Author: nitin27may

.github/workflows/template-publish.yml

@@ -82,12 +82,18 @@ jobs:
             # Copy as main README.md in the template output root
             Copy-Item -Path "./template-src/README.template.md" -Destination "./template-output/README.md"
             
-            # Create docs directory for NuGet's readme reference
-            New-Item -Path "./template-output/docs" -ItemType Directory -Force
-            Copy-Item -Path "./template-src/README.template.md" -Destination "./template-output/docs/README.md"
+            Write-Host "✅ README file set up successfully at template-output/README.md"
             
-            Write-Host "✅ README files set up successfully"
-          } 
+            # Verify the file exists and has content
+            if (Test-Path "./template-output/README.md") {
+              $fileContent = Get-Content -Path "./template-output/README.md" -Raw
+              $contentLength = $fileContent.Length
+              Write-Host "README.md file size: $contentLength bytes"
+            } else {
+              Write-Error "README.md was not copied correctly"
+            }
+          } else {
+            Write-Error "README.template.md not found in template-src directory"
 
       - name: Copy and update .nuspec file
         shell: pwsh
@@ -153,6 +159,29 @@ jobs:
         run: |
           nuget pack ./template-output/CleanArchitecture.FullStack.Template.nuspec -OutputDirectory ./nupkg
 
+      - name: Verify template package contents
+        shell: pwsh
+        run: |
+          # Extract and verify the NuGet package contents to ensure README is included
+          $packagePath = Get-ChildItem -Path "./nupkg/*.nupkg" | Select-Object -First 1 -ExpandProperty FullName
+          $extractPath = "./nupkg-extracted"
+          
+          Write-Host "Extracting NuGet package to verify contents..."
+          if (Test-Path $extractPath) {
+            Remove-Item -Path $extractPath -Recurse -Force
+          }
+          New-Item -Path $extractPath -ItemType Directory | Out-Null
+          
+          # Extract the package using NuGet
+          nuget install CleanArchitecture.FullStack.Template -Source "./nupkg" -OutputDirectory $extractPath -ExcludeVersion
+          
+          # Verify README exists
+          $readmePath = "$extractPath/CleanArchitecture.FullStack.Template/README.md"
+          if (Test-Path $readmePath) {
+            Write-Host "✅ README.md exists in the NuGet package"
+          } else {
+            Write-Error "❌ README.md is missing from the NuGet package"
+
       - name: Test template package
         run: |
           dotnet new install ./nupkg/CleanArchitecture.FullStack.Template.${{ env.TEMPLATE_VERSION }}.nupkg
@@ -163,22 +192,19 @@ jobs:
           dotnet new --list | findstr "cleanarch"
           
           # Create project from template with parameters from template.json
-          dotnet new cleanarch --organization TestCompany --projectName TestProject
+          # Test both with camelCase and PascalCase to verify both work
+          dotnet new cleanarch-fullstack --Organization TestCompany --ProjectName TestProject
           
           # List files to verify creation
           dir
 
       - name: Test template package with organization
         run: |
-          dotnet new install ./nupkg/CleanArchitecture.FullStack.Template.${{ env.TEMPLATE_VERSION }}.nupkg
           mkdir test-project-with-org
           cd test-project-with-org
           
-          # Verify template installed correctly
-          dotnet new --list | findstr "cleanarch"
-          
           # Create project from template with organization parameter
-          dotnet new cleanarch --organization TestCompany --projectName TestProjectWithOrg
+          dotnet new cleanarch-fullstack --organization TestCompany --projectName TestProjectWithOrg
           
           # List files to verify creation
           dir
@@ -189,7 +215,7 @@ jobs:
           cd test-project-no-org
           
           # Create project from template without organization parameter
-          dotnet new cleanarch --projectName TestProjectNoOrg
+          dotnet new cleanarch-fullstack --projectName TestProjectNoOrg
           
           # List files to verify creation
           dir
@@ -200,7 +226,7 @@ jobs:
           cd test-project-no-angular
           
           # Create project from template without Angular
-          dotnet new cleanarch --organization TestCompany --projectName TestProjectNoAngular --includeAngular false
+          dotnet new cleanarch-fullstack --organization TestCompany --projectName TestProjectNoAngular --includeAngular false
           
           # Verify that frontend directory is not created
           if (Test-Path "./frontend") {
@@ -215,7 +241,7 @@ jobs:
         shell: pwsh
         run: |
           # Test with organization - should create folder YourCompany.TestProject
-          dotnet new cleanarch --organization YourCompany --projectName TestProject
+          dotnet new cleanarch-fullstack --Organization YourCompany --ProjectName TestProject
           
           if (Test-Path "YourCompany.TestProject") {
             Write-Host "✅ YourCompany.TestProject folder created successfully"
@@ -225,7 +251,7 @@ jobs:
           }
           
           # Test without organization - should create folder TestProjectNoOrg
-          dotnet new cleanarch --projectName TestProjectNoOrg
+          dotnet new cleanarch-fullstack --ProjectName TestProjectNoOrg
           
           if (Test-Path "TestProjectNoOrg") {
             Write-Host "✅ TestProjectNoOrg folder created successfully"
@@ -235,7 +261,7 @@ jobs:
           }
           
           # Test with explicit output folder
-          dotnet new cleanarch --organization YourCompany --projectName TestProject -o CustomFolder
+          dotnet new cleanarch-fullstack --Organization YourCompany --ProjectName TestProject -o CustomFolder
           
           if (Test-Path "CustomFolder") {
             Write-Host "✅ CustomFolder created successfully"

template-src/CleanArchitecture.FullStack.Template.nuspec

@@ -14,15 +14,15 @@
     <license type="expression">MIT</license>
     <projectUrl>https://github.com/nitin27may/clean-architecture-docker-dotnet-angular</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-    <copyright>Copyright © Nitin Singh 2024</copyright>
+    <copyright>Copyright © Nitin Singh 2025</copyright>
     <summary>A full-stack template using Clean Architecture principles with .NET 9 API backend and Angular 19 frontend, containerized with Docker.</summary>
-    <readme>docs\README.md</readme>
+    <readme>README.md</readme>
   </metadata>
   <files>
     <!-- Include all template content files but exclude binaries and temp files -->
-    <file src="**\*" target="content" exclude="**\bin\**;**\obj\**;**\.git\**;**\.vs\**;**\.vscode\**;**\node_modules\**;**\.angular\**;**\docs\**" />
+    <file src="**\*" target="content" exclude="**\bin\**;**\obj\**;**\.git\**;**\.vs\**;**\.vscode\**;**\node_modules\**;**\.angular\**;docs\**;*.nuspec" />
 
     <!-- Explicitly include the README for NuGet package display -->
-    <file src="docs\README.md" target="docs\" />
+    <file src="README.md" target="" />
   </files>
 </package>

template-src/CreateTemplate.ps1

@@ -148,6 +148,13 @@ $templateJson = @{
             defaultValue = "YourCompany"
             replaces = $OrganizationNamespace
         }
+        ProjectName = @{
+            type = "parameter"
+            datatype = "string"
+            description = "Name of the project that will be used throughout the solution."
+            defaultValue = "MyApp"
+            replaces = "ProjectNamePlaceholder"
+        }
         SkipRestore = @{
             type = "parameter"
             datatype = "bool"
@@ -161,7 +168,6 @@ $templateJson = @{
             defaultValue = $true
         }
     }
-    # Modified sources configuration to fix validation errors
     sources = @(
         @{
             modifiers = @(

template-src/README.template.md

@@ -22,13 +22,13 @@ This template provides a starting point for creating a Clean Architecture soluti
 
    ```bash
    # Create with organization - output folder will be "YourCompany.MyApp"
-   dotnet new cleanarch --organization YourCompany --projectName MyApp
+   dotnet new cleanarch-fullstack --Organization YourCompany --ProjectName MyApp
 
    # Create without organization - output folder will be just "MyApp"
-   dotnet new cleanarch --projectName MyApp
+   dotnet new cleanarch-fullstack --ProjectName MyApp
 
    # Create in a specific folder (overrides default folder behavior)
-   dotnet new cleanarch --organization YourCompany --projectName MyApp -o CustomFolder
+   dotnet new cleanarch-fullstack --Organization YourCompany --ProjectName MyApp -o CustomFolder
    ```
 
 3. **Navigate to the project directory:**
@@ -56,58 +56,58 @@ This template provides a starting point for creating a Clean Architecture soluti
 
 ```bash
 # Full-stack application with organization name
-dotnet new cleanarch --organization Acme --projectName ECommerce
+dotnet new cleanarch-fullstack --Organization Acme --ProjectName ECommerce
 
 # Full-stack application without organization name
-dotnet new cleanarch --projectName ECommerce
+dotnet new cleanarch-fullstack --ProjectName ECommerce
 ```
 
 ### Backend-only Application
 
 ```bash
 # Create backend-only application (exclude Angular)
-dotnet new cleanarch --organization Acme --projectName ApiService --includeAngular false
+dotnet new cleanarch-fullstack --Organization Acme --ProjectName ApiService --includeAngular false
 
 # Backend-only application without organization name
-dotnet new cleanarch --projectName ApiService --includeAngular false
+dotnet new cleanarch-fullstack --ProjectName ApiService --includeAngular false
 ```
 
 ### Custom Output Location
 
 ```bash
 # Specify a custom output folder
-dotnet new cleanarch --organization Acme --projectName ECommerce -o ./projects/ecommerce-app
+dotnet new cleanarch --Organization Acme --ProjectName ECommerce -o ./projects/ecommerce-app
 
 # Specify output folder without organization name
-dotnet new cleanarch --projectName ECommerce -o ./projects/ecommerce-app
+dotnet new cleanarch --ProjectName ECommerce -o ./projects/ecommerce-app
 ```
 
 ### Combining Options
 
 ```bash
 # Backend-only application with custom output folder
-dotnet new cleanarch --organization Acme --projectName ApiService --includeAngular false -o ./apis/service
+dotnet new cleanarch --Organization Acme --ProjectName ApiService --includeAngular false -o ./apis/service
 
 # Full options example
-dotnet new cleanarch --organization Acme --projectName ECommerce --includeAngular true -o ./projects/ecommerce-app
+dotnet new cleanarch --Organization Acme --ProjectName ECommerce --includeAngular true -o ./projects/ecommerce-app
 ```
 
 ## Template Parameters
 
-- `--organization`: Optional organization or company name to be used in namespaces. If specified, namespaces will be formatted as `YourCompany.MyApp.Feature`. If not specified, namespaces will be formatted as `MyApp.Feature`.
-- `--projectName`: The name of the project. Default is `MyApp`.
+- `--Organization`: Optional organization or company name to be used in namespaces. If specified, namespaces will be formatted as `YourCompany.MyApp.Feature`. If not specified, namespaces will be formatted as `MyApp.Feature`.
+- `--ProjectName`: The name of the project. Default is `MyApp`.
 - `--includeAngular`: Boolean flag to indicate whether to include the Angular frontend project. Default is `true`.
-- `-o|--output`: Optional parameter to specify a custom output folder. If not specified, the output folder will be `<organization>.<projectName>` if organization is provided, or just `<projectName>` if it isn't.
+- `-o|--output`: Optional parameter to specify a custom output folder. If not specified, the output folder will be `<Organization>.<ProjectName>` if organization is provided, or just `<ProjectName>` if it isn't.
 
 ## Output Folder Naming
 
 The template uses the following rules to determine the output folder name:
 
 | Command Parameters | Output Folder |
 | ------------------ | ------------- |
-| `--organization YourCompany --projectName MyApp` | `YourCompany.MyApp` |
-| `--projectName MyApp` (no organization) | `MyApp` |
-| `--organization YourCompany --projectName MyApp -o CustomFolder` | `CustomFolder` |
+| `--Organization YourCompany --ProjectName MyApp` | `YourCompany.MyApp` |
+| `--ProjectName MyApp` (no organization) | `MyApp` |
+| `--Organization YourCompany --ProjectName MyApp -o CustomFolder` | `CustomFolder` |
 
 ## Directory Structure
 

template-src/template.json

@@ -5,7 +5,7 @@
   "name": "Clean Architecture Docker Angular",
   "identity": "NitinSoft.CleanArch.Template",
   "groupIdentity": "NitinSoft.CleanArch.Template",
-  "shortName": "cleanarch",
+  "shortName": "cleanarch-fullstack",
   "sourceName": "ProjectNamePlaceholder",
   "preferNameDirectory": true,
   "tags": {
@@ -23,6 +23,7 @@
     "projectName": {
       "type": "parameter",
       "datatype": "text",
+      "description": "Name of the project that will be used throughout the solution.",
       "defaultValue": "MyApp",
       "replaces": "ProjectNamePlaceholder"
     },