homely/homely.aspnetcore.webapi.template

An opinionated ASP.NET Core 2.2 Web API template for new web applications.

This is the home page / project overview for Homely.com.au open source projects.

At Homely, most of our development is done in private (with private repositories) but we do encourage to try and see if some of the code we do in our day-to-day work (which is used in our private systems) can be abstracted enough into a public project, for others to take advantage of.

We hope that other developers like yourself might find some of our efforts useful and/or enspiring!

---

Contributing

Discussions and pull requests are encouraged :) Please ask all general questions in this repository or pick a specialized repository for specific, targetted issues. We have a contributing document which goes into detail about how to do this.

Code of Conduct

Yep, we also have a code of conduct which applies to all repositories in the GitHub Homely.com.au organisation.

Languages currently supported

• C# on .NET. Packages available on NuGet.

Feedback

Check out the contributing page to see the best places to log issues and start discussions.

---

homely.aspnetcore.webapi.template's Issues

Decide on a Logging Sink/Target.

NLog or Serilog?

and once decided, which sink/target should we send the data to?

Update template to support optional features

Currently the only customization in the template is the name.

Mandatory inclusions:

• MediatR

Optional inclusions (via 'params' in template)

• Authentication
• Controllers/models
• Dapper
• Redis

Add code coverage

ETags - how do we handle our data to be easily cached?

How can our data (via a GET request) be easily cached?

• Do we want to just create an E-Tag on the response (based on the payload data, of course)
• Do we care that, if a request arrives with some E-Tag header, we check an in-memory cache of previously determined responses? This means ... we'll be storing stuff in In-Mem RAM ...

Add CI/CD

Required:

• Build + test on PR/master commit
• Release template package to NuGet via seperate/manual release (guess GitHub releases again?)

Add HealthChecks

Doesn't sound like this has been brought into ASP.NET Core 2.1.. so we'll need to use this seperate lib:
https://github.com/dotnet-architecture/HealthChecks

Complete converting the web app project to a "dotnet new" template.

Complete the testing/tweaking of this web app project to enable dotnet new homelyapi <options>.

Currently, having difficulty with the testing of this, while trying to not use nuget pack but instead use dotnet pack.

Update obsolete methods called to NSwag.

The following methods are now flagged as Obsolete by NSwag. Need to fix/update this:

Try using Dependabot

https://www.jerriepelser.com/blog/updating-net-dependencies-dependabot/