alexalvess / aurora-api-project

Aurora is a project developed in .NET 6, where it aims to show how to create something using an architecture, in layers, simple and approaching, in a simplistic way, some concepts such as DDD.

Home Page:http://aurora-project.azurewebsites.net/swagger/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

What is Aurora project?

It's an open source project, written in .NET, currently in version 6.

The project's goal is to show how can we use the Hexagonal Architecture concepts and using some concepts like DDD to create an API.

Business proposal:

This project is a simple PPE Management. The principle idea is to register workers and PPE and, with this data, allow to transfer PPE to a worker. Besides that, this system allows that you see all the PPE and who has a PPE and notify if the PPE is near to expire.

Abbreviations:

  • NIN: National Insurance Number (as CPF in Brazil)
  • PPE: Personal Protective Equipment
  • DDD: Domain Driven Design

How to use:

  1. Clone this project to into your machine
  2. Run MongoDB container (like on Docker) 2.2. This project using user-secrets, so you need to configure it 2.1. Inform the right connection string in project
  3. Finally, build and run the application

For user-secrets:

dotnet user-secrets set "ConnectionStrings:MongoDb" "[LOCAL_MONGODB_CONNECTIONSTRING]"

Technologies:

  • .NET 7
  • C# previewer
  • MongoDB
  • FluentValidation
  • Swagger
  • .NET Core Native DI
  • Serilog

Architecture:

  • Hexagonal Architecture
  • Domain Validations
  • Domain Notifications
  • Repository Pattern
  • Notification Pattern
  • Value Types
  • Monolith

Principles:

  • Domain Driven Design
  • Clean Code
  • S.O.L.I.D.

Hexagonal Architecture

Design Architectural

Why did I choose this design?

  • It's very easy to include, or exclude, a framework or external library in a separate DLL.
  • The focus is in Core layer. So the business rules/your domain stay very uncoupled of external things.
  • I'm an enthusiast for this Design 😁🤓

Why Aurora?

The name Aurora came from the natural event called Aurora Borealis. It is a scientific event described by the interaction between the earth's magnetic layer and energized particles from the solar wind.

A curiosity about such an event is that what we see in photographs is not always the same image that is seen live.

For more information, look this link.

About:

The Aurora project was developed by Alex Alves.


References:

About

Aurora is a project developed in .NET 6, where it aims to show how to create something using an architecture, in layers, simple and approaching, in a simplistic way, some concepts such as DDD.

http://aurora-project.azurewebsites.net/swagger/index.html


Languages

Language:C# 98.9%Language:Dockerfile 1.1%