cds-snc / hello-esdc

hello-esdc

Project structure/files

• database (for seed .sql files)
• src
  • HelloESDC.API (.NET Core webapi project)
  • Web
    • WebSPA (where we'll build our sample SPA frontend)
    • WebWxT (where we'll build our sample WxT frontend)
• test (for tests - may move to sub-project folders?)

Docker

There is a Dockerfile for the HelloESDC.API sub-project that will build a container for the API:

cd src/HelloESDC.API
docker build -t hello-esdc-api .

There are also empty Dockerfiles in the src/Web/WebSPA and src/Web/WebWxT folders for future use.

Running

There is a basic docker-compose.yml file at the root that will bring up the api and a postgres database. This is just taken from some example code (see References below), we don't have to stick with Postgres.

There currently is no interaction between the containers, just sample code at the moment.

You can bring up the containers by doing this:

1. Navigate to project root in terminal
2. Generate migration script: sh util/build_migrations.sh
3. Launch Docker containers: docker-compose up --build

And the api will be available at: localhost:8000/api/values

To stop and reset:

1. Exit the apps: CTRL+C
2. Remove volumes: docker-compose down

Todo

There are quite a few pieces still missing, including:

• Tests
• CI

References

Medium post example of .net core webapi project with postgresql database:

• https://medium.com/front-end-weekly/net-core-web-api-with-docker-compose-postgresql-and-ef-core-21f47351224f
• https://github.com/rajvirtual/docker-aspnetcore-postgresql

Indepth article about Microservices Architecture in .NET, plus a reference application

• https://docs.microsoft.com/en-us/dotnet/standard/microservices-architecture/
• https://github.com/dotnet-architecture/eShopOnContainers

hello-esdc's Issues

ORM Tool

It's pretty common to use an Object Relational Mapping tool when doing DB stuff in .Net.

I really liked Dapper as it's a very lightweight Object Mapper

https://github.com/StackExchange/Dapper

Entity Framework is very very heavy,
Dapper is what Stack Overflow uses for it's database work and it supports postgresql.

Implement the Mediator Pattern?

I've used the mediatr project https://github.com/jbogard/MediatR in the past to decouple my business logic away from our controllers.

I've found on non-trivial applications it can really help to decouple actions in Controllers and makes things a little more testable.

It can be a bit overkill for small projects however.

https://github.com/jbogard/MediatR/wiki

AutoFormat

Their are a couple of options for auto-formatting of code.

The Resharper CLI Tools has a tool called CleanupCode that will autoformat your code based on some rules when run.

Their is also a Roslyn Analyzer called dotnet-format that will autoformat based on a .editorconfig file

Checkout a list of some other dotnet tools here: https://github.com/natemcmaster/dotnet-tools