There should be a distributed .NET Core scaffolder for standardised API development

[willmcvay]

Background context or User story:

To standardise development across the businesses, there should be a template application for .NET core applications

Specification or Acceptance Criteria:

Final spec to be defined by @plittlewood-rpt but broadly:

• Should be a standard microservices template, adhering to Platform internal best practices (this ticket)
• Should be distributed via Nuget or similar
• Should be flexible enough to be used at any group business
• Should have AWS CDK scripts included (#10519)
• Should have options to include SQL and / or document DBs (this ticket)
• Should have a basic gateway authorizer (#10518)

Considerations

• Should we use an API to do the grunt work to manage permissions (ie so developers don't have to have access tokens setup etc just to use the scaffolder). If so the CLI tool is just a dumb wrapper that asks questions and makes HTTP requests
  • If we use an API, what should the feedback loop to developers look like?
• Should the scaffolder be able to push the project to a Github repo (optional input from the user)
• Should we build public packages for interacting with Reapit Connect and Platform?
• Should we take more of a clean approach to the project and physically split the projects up to enforce layered architecture (could be overkill for some projects, but consistency is probably better)
• Should we add UoW pattern to the template (probably)
• How should we enforce code style? Project specific rulesets, shared editorconfig etc?
  • We need to define these rules
• What should we include in the build pipelines
  • Code analysis
  • Test coverage
  • Commit linting?
  • Auto gen release notes?
• Any other changes to suggest to the existing Reapit.Templates.Serverless project to demonstrate best practices

Specification

• Update Reapit.Templates.Microservice and Reapit.Templates.Serverless to .NET 6 and ensure request pipeline configuration is updated to remove specific items
• Build new CDK project to create infrastructure. Need to consider what infra needs building here. TBC with Nick Tiley

[plittlewood-rpt]

@ntiley @willmcvay we need to discuss this please. Our existing template has a load of 'platform related bits and pieces' in it by default (think billing events, scope handling etc). A lot of that probably needs removing here. I need to understand how vanilla you need me to go please. Infrastructure wise, we need to be careful as well as new projects are meant to go through the relevant DevOps team to own the infrastructure which would mean that should actually be excluded here. This feels more about getting a consistent project structure across the group. If so, this probably ties in nicely with some work we need to do to agree on code styles/guidelines in a bit more detail so we can get those rules embedded into the template.