jadhielv/itl

Sample Web API implementation with .NET Core and DDD using Clean Architecture.

Hi there - I'm Jadhiel!

• 🔭 I’m a Senior Software Developer from the Dominican Republic 🇩🇴.
• 👨🏻‍💻 I’m contributing 29 open-source projects and maintain Jadhielv in my spare time.
• 🌍 I'm mostly active within the DotNET and Vue communities.
• 🤓 Willing to contribute to open-source development projects.
• 🌱 I’m currently learning about PWAs, TypeScript & Flutter.
• 📅 I have attended a few conferences such as CodeCampSDQ, GitHub Universe, Caribbean Developers Conference, DevFest Santo Domingo, GitLab Commit, MonkeyFestUSA, Visual Studio Launch, VS Code Day and Global Azure.

🚀 Skills:

📊 Github Stats:

💻 Profile

NOTE: Top languages do not indicate my skill level or something like that, it's a GitHub metric of which languages I've the most code.

⚡ Recent Activity

1. 🎉 Merged PR #536 in Jadhielv/ITL
2. 🎉 Merged PR #324 in AngelGarcia13/DominicanWhoCodes
3. 🎉 Merged PR #149 in Jadhielv/ACGSS
4. 🎉 Merged PR #148 in Jadhielv/ACGSS
5. 🗣 Commented on #536 in Jadhielv/ITL

itl's Issues

Create a code of conduct

Is your feature request related to a problem? Please describe.
Create a code of conduct

Describe the solution you'd like
Use Contributor Covenant

Use .ReverseMap()

You could use .ReverseMap() instead of creating another Profile for the opposite Mapping.

https://github.com/Jadhielv/KCTest/blob/860a39e914208026cd2283f85526f662f07f1548/Backend/src/KCTest.Infrastructure/Mapper/MappingProfileToDTOs.cs#L11

Crosscutting project ?

Hello,

I need to use some enums in Application or Domain, it's not a good idea to create a crosscutting project to place these enums ? Same for exceptions, in Application you can throw an exception catched in the Middleware in the API.

Thanks,

[TODO]: Log InternalServerError Exceptions

ITL/Backend/src/ITL.API/Middlewares/ExceptionHandler.cs

Line 36 in a87364f

// TODO: Log InternalServerError Exceptions

Handling InternalServerError exceptions in C# involves catching the error, logging it, and returning a suitable response to the client. If you require any further information, please do not hesitate to contact me or our collaborator, @nminaya, he can provide more details.

Update NuGet Packages to the latest version

Update all the packages listed

Is your feature request related to a problem? Please describe.
Update dependencies and devDependencies to the latest version

Describe the solution you'd like
Use npm-update

Describe alternatives you've considered
NONE

Additional context
NONE

Update to .NET 6.0

• Migrate from ASP.NET Core 5.0 to 6.0
• Change the target framework of all projects.

<TargetFramework>net6.0</TargetFramework>

Why don't you use global error handler?

Hello guys, I hope you are doing well, I would like to recommend using a global error handler instead of catching things everywhere.

here is a example: handler

But if there is a reason for this approach, can you tell me what it is?
https://github.com/Jadhielv/KCTest/blob/f4eef8b0581c24482439604ab066935c54d95b1f/Backend/src/KCTest.Application/Services/PermissionService.cs#L40

Implement File Scoped Namespaces

C# Guide

Use .AddFluentValidation() on Startup.cs

Instead of using the validators on the services you could use .AddFluentValidation() on Startup.cs, so that the validation will be done automatically on each request
https://github.com/Jadhielv/KCTest/blob/860a39e914208026cd2283f85526f662f07f1548/Backend/src/KCTest.Application/Services/PermissionService.cs#L19

Create develop branch

Make services use pagination

The PermissionService and PermissionTypeService are not using the Pagination parameter
https://github.com/Jadhielv/KCTest/blob/77649d2e6609ba32070c034b2edb3b7680626fbb/Backend/src/KCTest.Application/Services/PermissionService.cs#L77-L83

https://github.com/Jadhielv/KCTest/blob/77649d2e6609ba32070c034b2edb3b7680626fbb/Backend/src/KCTest.Application/Services/PermissionTypeService.cs#L71-L77

Use the Pagination parameter and create or modify the GET endpoints.

Error NU1107: Version conflict detected for AutoMapper

Migrate from .NET 6.0 to 7.0

.NET platform has a new major release. Now supporting .NET 7 is a major release that improves developer quality by improving fundamentals like performance, functionality, and usability.

Migration Article -> Migrate from ASP.NET Core 6.0 to 7.0

IStringLocalizer in Application project

Hello,

The application is multilanguage means, I have to return an error message in the right language.

When I do this in the API project, it's ok I get the right value for Article

In the Startup.cs

services.AddLocalization(options => options.ResourcesPath = "Resources");
services.AddControllersWithViews()
        .AddViewLocalization
        (LanguageViewLocationExpanderFormat.Suffix)
        .AddDataAnnotationsLocalization();
services.Configure<RequestLocalizationOptions>(options => {
    var supportedCultures = new[] { "fr-BE", "nl-BE", "en-US" };
    options.SetDefaultCulture(supportedCultures[0])
        .AddSupportedCultures(supportedCultures)
        .AddSupportedUICultures(supportedCultures);
});

In the controller :

private readonly IStringLocalizer<MyController> _localizer;
public MyController(IStringLocalizer<MyController> localizer)
{    _localizer = localizer; }

public ActionResult Get()
{   var article = _localizer["Article"];
    return Ok();
}

But I have to use that in the Application project

Then I do this :

public class MyService : IMyService
{
   private readonly IStringLocalizer<MyService> _localization;
    public MyService(IStringLocalizer<MyService> localization)
    {
	_localization = localization;
    }	
    public void Search()
    {
        var res = _localization["Article"];
    }
}

In res I get the value Article (the key) but not the value, I tried to move the resources files to Application project but still not work.

How can I do to fix this ?

Thanks

Query in nested object

Hello,

See explanation in 'MyMethod'

thanks,

public class Product : BaseEntity
{
    public string Name { get; set; }
    public ICollection<ProductPrice> ProductPrices { get; set; }
}

public class ProductPrice : BaseEntity
{
    [Column(TypeName = "decimal(18, 2)")]
    public decimal Price { get; set; }
    public bool IsActive { get; set; }
    public Product Product { get; set; }
}

public async Task<Product> MyMethod (int id)
{

   // In the query below, I'd like get in the result, the ProductPrice collection but only the Product where IsActive is true
   // how do this with your generic repo ?

   var product = await _unitOfWork.Products.First(x => x.Id == id);   
    
   return product;
}

Create unit tests for Validators

You should create unit tests for your FluentValidation Validators

Documentation: https://docs.fluentvalidation.net/en/latest/testing.html

Services shouldn't return HttpResponse

Services shouldn't return HttpResponses

https://github.com/Jadhielv/KCTest/blob/4b2d6219d03bd910d430fe54cffe5524caa2784b/Backend/src/KCTest.Domain/Services/IPermissionService.cs#L9

HttpResponses should be handled in the controller.

Register all validators from assemblies

When the project grows up, you will have more validators and this registration will be a bit longer.
https://github.com/Jadhielv/KCTest/blob/860a39e914208026cd2283f85526f662f07f1548/Backend/src/KCTest.API/Startup.cs#L41
You can instead register all validators from the Assemblies using:

services.AddFluentValidation(config => config.RegisterValidatorsFromAssemblies(listOfAssemblies));

Add some unit tests

Describe alternatives you've considered
Unit Test Through Mocking Using Moq Framework.

Additional context
NONE

Use automatic migration execution at startup

You can automatically execute the database migrations when the app is setting up at Startup with context.Database.Migrate()

Repositories of the UOW

Instead of create a new instance of the repositories you can use DI (because you already have the interfaces) for inject the repositories the UOW needs.

[TODO]: Find a way to inject the repositories and share the same context without creating an instance.

ITL/Backend/src/ITL.Infrastructure/Extensions/UnitOfWorkExtension.cs

Line 12 in a87364f

//TODO: Find a way to inject the repositories and share the same context without creating a instance.

In C#, you can use the Dependency Injection (DI) pattern to provide instances of repositories to your application without having to create an instance of each repository yourself. If you require any further information, please do not hesitate to contact me or our collaborator, @nminaya, he can provide more details.

[TODO]: Use JSON Converter

ITL/Backend/src/ITL.API/Middlewares/ExceptionHandler.cs

Line 40 in a87364f

// TODO: Use Json converter

In C#, you can use the Newtonsoft.Json library to convert objects to and from JSON. If you require any further information, please do not hesitate to contact me or our collaborator, @nminaya, he can provide more details.

How add custom method in Repository

Hello,

I'd like add a custom method in the PermissionRepository but I don't have access to the DBSet of the base class Repository.

What is the best way to do this ?

Thanks,

Validation on creating a new object

If you're adding something new, it is supposed not to have an Id. So I think this validation is useless:

https://github.com/Jadhielv/KCTest/blob/4b2d6219d03bd910d430fe54cffe5524caa2784b/Backend/src/KCTest.Application/Services/PermissionService.cs#L29

Add action-semantic-pull-request GitHub Action

Guide -> semantic-pull-request

Npm install error

Running npm install command in the kctest-frontend folder throws the following error:

Query in nested object (Update)

    You can filter using LinQ:

var product = await _unitOfWork.Products.Where(x => x.Id == id).Select(x => new ProductDto { x.Name, ActiveProductPrices = x.ProductPrices.Where(p => p.IsActive) }).First();

Does not work because you don't have access Products but you have access to ProductRepository.

Originally posted by @nminaya in #220 (comment)

Create contributing guidelines

Is your feature request related to a problem? Please describe.
The purpose is describing how others may contribute content to the project.

Describe the solution you'd like
Use Good-CONTRIBUTING.md-template or whatever you prefer.

Describe alternatives you've considered
NONE

Additional context
NONE

Test suite failed to run

Is your feature request related to a problem?
FAIL test/e2e/specs/test.js

● Test suite failed to run

Your test suite must contain at least one test.

  at onResult (D:\Repositories (GitHub)../../../KCTest/kctest-frontend/node_modules/@jest/core/build/TestScheduler.js:175:18)
  at D:\Repositories (GitHub)../../../KCTest/kctest-frontend/node_modules/@jest/core/build/TestScheduler.js:304:17
  at D:\Repositories (GitHub)../../../KCTest/kctest-frontend/node_modules/emittery/index.js:260:13
      at Array.map (<anonymous>)
  at Emittery.Typed.emit (D:\Repositories (GitHub)../../../KCTest/kctest-frontend/node_modules/emittery/index.js:258:23)

FAIL test/unit/specs/HelloWorld.spec.js
● Test suite failed to run

Configuration error:

Could not locate module @/components/HelloWorld mapped as:
D:\Repositories (GitHub)\KCTest\kctest-frontend\src\$1.

Please check your configuration for these entries:
{
  "moduleNameMapper": {
    "/^@\/(.*)$/": "D:\Repositories (GitHub)\KCTest\kctest-frontend\src\$1"
  },
  "resolver": undefined
}

  1 | import Vue from 'vue'
> 2 | import HelloWorld from '@/components/HelloWorld'
    | ^
  3 | 
  4 | describe('HelloWorld.vue', () => {
  5 |   it('should render correct contents', () => {

  at createNoMappedModuleFoundError (D:\Repositories (GitHub)../../../KCTest/kctest-frontend/node_modules/jest-resolve/build/index.js:551:17)
  at Object.<anonymous> (D:\Repositories (GitHub)../../../KCTest/kctest-frontend/test/unit/specs/HelloWorld.spec.js:2:1)

Describe the solution you'd like
Adjust Configuration of Jest. Documentation: https://jestjs.io/docs/en/configuration

Describe alternatives you've considered
NONE

Additional context
NONE