Proposed Alternative DOTNET Repository Layout

Layout for GitHub Repo for Blazor Web App with API and shared Logic layer and server-side Data Layer.

I’m thinking that a directory layout for Solutions that represents the relationship of projects would be good. Also, pairing test projects…


This content originally appeared on DEV Community and was authored by The Sharp Ninja

Layout for GitHub Repo for Blazor Web App with API and shared Logic layer and server-side Data Layer.

I'm thinking that a directory layout for Solutions that represents the relationship of projects would be good. Also, pairing test projects with their library being tested.

Proposed Layout 

📄 .gitignore                // Global Git Ignore
📄 README.md                 // README for entire repository
📄 LICENSE                   // LICENSE for entire repository
📄 nuget.config              // NuGet Configuration
📂 .github                   // Github config
  📂 workflow                // Github Workflows
    📄 cd.yml                // Continuous Integration Pipeline
    📄 ci.yml                // Continuous Deployment Pipeline
📂 .idea                     // (hidden) Rider config
📂 .tools                    // Dependent Tooling
  📂 Cake                    // Cake Build Tooling
📂 .vs                       // (hidden) Visual Studio Config
📂 .vscode                   // VS Code Config
  📄 settings.json           // VS Code Solution Settings
  📄 tasks.json              // VS Code Task Definitions
  📄 launch.json             // VS Code Launch Definitions
  📄 extensions.json         // VS Code Extension Recomendations
📂 _artifacts                // Built Artifacts
  📂 npm                     // Built NPM Modules
  📂 nuget                   // Built NuGet Packages
  📂 other                   // Other Built Artifacts
📂 _build                    // Nuke or Cake
  📂 .nuke                   // Nuke Project
    📄 Build.cs              // BUKE Targets
    📄 Build.csproj          // NUKE Build Project
📂 _cd                       // CD Config
  📄 nuke-cd.yml             // CD Config for NUKE
📂 _ci                       // CI Config
  📄 nuke-ci.yml             // CI Config for NUKE
📂 _lib                      // Loose dependencies
📂 _requirements             // Loose requirements docs
📂 _scripts                  // Loose PowerShell Scripts
  📄 publish.ps1             // Push artifacts to repositories
  📄 helpers.psm1            // PowerShell Module of helper functions
📂 MySolution                // Start of Visual Stduio Solution
  📄 Directory.Build.Props   // Global MSBuild Configuration
  📄 MySolution.sln          // Visual Studio Solution File
  📂 Data
    📄 Directory.Build.Props // Data-Tier MSBuild Configuration
    📂 _integration          // Data-Tier integration tests
    📂 _sql                  // Loose SQL Scripts
    📂 MyProject.Entities    // Project Grouping
      📂 docs                // Markdown based generated and/or manual docs
        📂 Generated         // Generated Documentation
          📂 <metadata folder> // DocFx Generated
          📂 api             // DocFx Generated
            📄 <namespace>.yml // DocFx Generated
            📄 <class>.yml   // DocFx Generated
          📄 toc.yml         // DocFx Generated
          📄 index.yml       // DocFx Generated
        📂 Pages             // Hand-created Documentation
          📄 page_about.md   // Index for MyProject.Entities Docs
          📄 page_support.md // Index for MyProject.Entities Docs
        📄 docfx.json        // DocFx Configuration
        📄 index.md          // Index for MyProject.Entities Docs
      📂 src                 // Library
        📂 Entities          // POCO Entities
        📂 Migrations        // Database Migrations
        📂 Repositories      // Repositories or DbContexts
        📄 MyProject.Entities.csproj
      📂 test                // Library Tests
        📂 Data              // Test Data
        📂 Mocking           // Mocking Objects
        📄 MyProject.Entities.Tests.csproj
  📂 Logic
    📄 Directory.Build.Props // Logic-Tier MSBuild Configuration
    📂 _integration          // Logic-Tier Integration Tests
    📂 MyProject.Rules
      📂 docs
        📂 Generated         // Generated Documentation
          📂 <metadata folder> // DocFx Generated
          📂 api             // DocFx Generated
            📄 <namespace>.yml // DocFx Generated
            📄 <class>.yml   // DocFx Generated
          📄 toc.yml         // DocFx Generated
          📄 index.yml       // DocFx Generated
        📂 Pages             // Hand-created Documentation
          📄 page_about.md   // Index for MyProject.Logic Docs
          📄 page_support.md // Index for MyProject.Logic Docs
        📄 docfx.json        // DocFx Configuration
        📄 index.md          // Index for MyProject.Logic Docs
      📂 src
        📂 Mapping           // Entities-to-Domain Models Mappings
        📂 MVC               // Real MVC (see: )
          📂 Controllers     // Controllers
          📂 Models          // POCO Domain Models
        📄 MyProject.Rules.csproj
      📂 test
        📄 MyProject.Rules.Tests.csproj
  📂 Services
    📄 Directory.Build.Props // Services-Tier MSBuild Configuration
    📂 _integration          // Services-Tier Integration Tests
    📂 MyProject.Api
      📂 docs
        📂 Generated         // Generated Documentation
          📂 <metadata folder> // DocFx Generated
          📂 api             // DocFx Generated
            📄 <namespace>.yml // DocFx Generated
            📄 <class>.yml   // DocFx Generated
          📄 toc.yml         // DocFx Generated
          📄 index.yml       // DocFx Generated
        📂 Pages             // Hand-created Documentation
          📄 page_about.md   // Index for MyProject.Api Docs
          📄 page_support.md // Index for MyProject.Api Docs
        📄 docfx.json        // DocFx Configuration
        📄 index.md          // Index for MyProject.Api Docs
      📂 src
        📄 MyProject.Api.csproj
      📂 test
        📄 MyProject.Api.Tests.csproj
  📂 UI
    📄 Directory.Build.Props // UI-Tier MSBuild Configuration
    📂 _assets               // Shared UI assets
      📂 css                 // Shared Styling
      📂 fonts               // Shared Fonts
      📂 images              // Shared Images
      📂 resources           // Shared Resource files
    📂 _integration          // UI-Tier Integration Tests
    📂 MyProject.Blazor
      📂 docs
        📂 Generated         // Generated Documentation
          📂 <metadata folder> // DocFx Generated
          📂 api             // DocFx Generated
            📄 <namespace>.yml // DocFx Generated
            📄 <class>.yml   // DocFx Generated
          📄 toc.yml         // DocFx Generated
          📄 index.yml       // DocFx Generated
        📂 Pages             // Hand-created Documentation
          📄 page_about.md   // Index for MyProject.UI Docs
          📄 page_support.md // Index for MyProject.UI Docs
        📄 docfx.json        // DocFx Configuration
        📄 index.md          // Index for MyProject.UI Docs
      📂 src
        📂 wwwroot
        📄 MyProject.Blazor.csproj
      📂 test
        📄 MyProject.Blazor.Test.csproj


This content originally appeared on DEV Community and was authored by The Sharp Ninja


Print Share Comment Cite Upload Translate Updates
APA

The Sharp Ninja | Sciencx (2021-12-23T22:04:39+00:00) Proposed Alternative DOTNET Repository Layout. Retrieved from https://www.scien.cx/2021/12/23/proposed-alternative-dotnet-repository-layout/

MLA
" » Proposed Alternative DOTNET Repository Layout." The Sharp Ninja | Sciencx - Thursday December 23, 2021, https://www.scien.cx/2021/12/23/proposed-alternative-dotnet-repository-layout/
HARVARD
The Sharp Ninja | Sciencx Thursday December 23, 2021 » Proposed Alternative DOTNET Repository Layout., viewed ,<https://www.scien.cx/2021/12/23/proposed-alternative-dotnet-repository-layout/>
VANCOUVER
The Sharp Ninja | Sciencx - » Proposed Alternative DOTNET Repository Layout. [Internet]. [Accessed ]. Available from: https://www.scien.cx/2021/12/23/proposed-alternative-dotnet-repository-layout/
CHICAGO
" » Proposed Alternative DOTNET Repository Layout." The Sharp Ninja | Sciencx - Accessed . https://www.scien.cx/2021/12/23/proposed-alternative-dotnet-repository-layout/
IEEE
" » Proposed Alternative DOTNET Repository Layout." The Sharp Ninja | Sciencx [Online]. Available: https://www.scien.cx/2021/12/23/proposed-alternative-dotnet-repository-layout/. [Accessed: ]
rf:citation
» Proposed Alternative DOTNET Repository Layout | The Sharp Ninja | Sciencx | https://www.scien.cx/2021/12/23/proposed-alternative-dotnet-repository-layout/ |

Please log in to upload a file.



There are no updates yet.
Click the Upload button above to add an update.

You must be logged in to translate posts. Please log in or register.

Related Posts