Skip to content

Latest commit

 

History

History
90 lines (46 loc) · 4.73 KB

Introduction.md

File metadata and controls

90 lines (46 loc) · 4.73 KB

⚙️ .config/dotnet-tools.json (more)

This file lists the .NET tools your project uses, like CSharpier (for code formatting) and dotnet-ef (for Entity Framework). Think of it as a list of extra helpers your project relies on.

Read more here.

⚙️ .github/workflows

This folder contains files that define automated workflows on GitHub. These workflows can be triggered by events like commits, pull requests, or other actions. They automate tasks like building, testing, and deploying your code.

📂 AppInfrastructure

This folder contains Dockerfiles and configuration related to the main application container itself

If you want to customize anything in this folder, you should have some knowledge about docker first (e.g., docker compose, dockerfile, etc.)

If you want to run, please check out how to run it here here

📂 Scripts (more)

This folder holds scripts used for various project tasks, such as building the project, publishing it, or running other custom operations.

Read more here.

📂 Src

This is where all your project's source code lives. It's the heart of your application.

🔧 .csharpierrc.json

This file configures the CSharpier code formatting tool. It defines rules for things like indentation (tabs vs. spaces), line length, and other stylistic choices. It keeps your code looking consistent. Just like how prettier works.

🔴 .gitattributes

This file tells Git how to handle specific files, especially regarding line endings (Windows vs. Linux style). It helps ensure consistency across different operating systems.

🔴 .gitignore

Crucially, this file specifies files and folders that Git should ignore and not track in version control. This prevents unnecessary files (like build outputs or temporary files) from cluttering your repository. Every project should have one.

📂 Directory.Build.props (more)

It file is used to define common MSBuild properties and configurations that apply to all projects in the directory and its subdirectories. By using this file, you will have following advantages:.

  • Centralized Configuration: Common settings (e.g., TargetFramework, OutputPath) are managed in one place, ensuring consistency across projects.

  • Simplified Maintenance: Instead of repeating the same configurations in every project file, you define them once here.

  • Overrides: Individual project files can override the settings if needed, offering flexibility. By using Directory.Build.props, you make the project setup cleaner, easier to maintain, and more scalable as the solution grows.

Read more here.

📦 Directory.Packages.props (more)

It is used to centralize and manage NuGet package references for the entire project. By consolidating package definitions in this file:

  • All modules in the project can reference dependencies from a single location.

  • Ensures consistent package versions across all modules, preventing version mismatches.

  • Simplifies dependency management, making it easier to update or modify package versions globally.

This approach benefits the entire project by promoting stability and reducing the risk of compatibility issues between modules.

Read more here.

🗂️ SetupProject.sln

This is the solution file. It organizes all the different projects (like your web API, class libraries, etc.) that make up your application. It's the main file you open in Visual Studio or other IDE like Rider

🔧 app-assembly.json

This file lists assembly names corresponding to code collections that provide services required by your application. Each listed assembly must include a RegistrationCenter class, responsible for registering that assembly's services.

Even if an assembly doesn’t currently contain services, it’s best practice to include a RegistrationCenter file. This ensures a smoother development process by avoiding future refactoring when services are added later. Think of it as proactive planning!

Read more about example workflow that uses this file here.

🌍 global.json (more)

This file specifies the .NET SDK version your project requires. This ensures everyone working on the project uses the same SDK, preventing compatibility issues.

Read more here.

🛠️ nuget.config (more)

This file configures how NuGet (the package manager) works. It lets you define where NuGet should look for packages and customize its behavior. It helps ensure consistent package management across the team.

Read more here.