oskardudycz/goldeneye

The CQRS flavoured framework that will speed up your WebAPI and Microservices development

GoldenEye

What is GoldenEye?

GoldenEye is a Full Stack framework written in .NET. The main goal of GoldenEye is to speed up your development process. It gathers most widely used frameworks in .NET world and pack them into a simple bootstrap Nuget packages. It also provide set of base classes, helpers, extensions that will help you with your daily work.

What do I get?

Complete Solution bootstrap - bottom up:

• CQRS and Domain Driven Development stack - sending and handling commands, queries, events (with usage of MediatR library),
• Messaging infrastructure - both internal based on MediatR and external with Kafka,
• CRUD Repositories and CRUD Application Services,
• Entity Framework (supports also Dapper, Marten)
• WebApi REST controllers,
• complete set up of dependency injection with automatic naming convention binding,
• AutoMapper preconfigured and automatic mappings registration,
• Validation flow with FluentValidation.NET,
• Examples of complete usage (Cinema Ticket Reservations),
• document database and event store support in Postgres with Marten framework,
• many more

How do I get started?

Add package to your project:

dotnet add package GoldenEye

Where can I get it?

Install packages from the Nuget package manager:

Packages:

• GoldenEye - full DDD flow for CQRS, DDD development. Basing on MediatR library gives the Command, Queries, Events handling. Repositories, Services, CRUD, helpers, extensions that will boost your development
• GoldenEye.Marten - extension to GoldenEye that gives possibility to use Postgres as Document Database and Event Store - thanks to Marten library
• GoldenEye.WebApi - base classes for API development like CRUD controllers, registration helpers, and many more
• GoldenEye.EntityFramework - extensions to GoldenEye for EntityFramework development (EF repositories, etc.)
• GoldenEye.Dapper - extensions to GoldenEye for Dapper development (Dapper repositories, etc.)
• GoldenEye.ElasticSearch - extensions to GoldenEye for ElasticSearch development (ElasticSearch repositories, etc.)
• GoldenEye.Kafka - extensions to GoldenEye for Kafka development (Kafka producer, concumer, etc.)

I found an issue or I have a change request

Feel free to create an issue on GitHub. Contributions, pull requests are more than welcome!

Support

💖 If this repository helped you - I'd be more than happy if you join the group of my official supporters at:

👉 Github Sponsors

GoldenEye is Copyright © 2015-2021 Oskar Dudycz and other contributors under the MIT license.

goldeneye's Issues

Production readiness

@oskardudycz Hi, do you think that GoldenEye is safe for production use cases or should we wait for stable 1.0 realase? If not do you know some production ready alternative (I know about eventflow but 1.0 version wasn't released yet)?

Upgrade packages to latest possibilities

1. Upgrade nuget packages to latest possibilities
2. Make the instalation process that doesn't need to run update-packages

Template is not working

I tried installing the template using dotnet new -i GoldenEye.WebApi.Template.SimpleDDD but couldn't get it to be listed in the .net templates.

To be sure it is not related to my machine I tried as well on my 2nd mac. Both have .net sdk 5.0.101 installed, my 2nd machine has also all other sdks from 2.2 installed.

The template is indeed downloaded and is shown under ~/.templateengine/dotnetcli/v5.0.101/content but it's not part of the list when you do dotnet new after installing.

The exact output if the installation is

dotnet new -i GoldenEye.WebApi.Template.SimpleDDD
  Determining projects to restore...
  Restored /Users/NAME/.templateengine/dotnetcli/v5.0.101/scratch/restore.csproj (in 616 ms).

and then the list does not show the GoldenEye template.

I found a workaround by specifying the direct path to the downloaded nupkg file

dotnet new -i ~/.templateengine/dotnetcli/v5.0.101/content/goldeneye.webapi.template.simpleddd.5.0.0.nupkg

I have also tried to find the issue but had no luck

Add Marten Backend Core library

Add backend processing module

Going from VS2017 branch. Add backend processing module to process background jobs.

1. Add new folder in the main structure: Cron
2. In created above folder add .NET Core class library projects :

• Backend.Cron - containing base abstractions (interfaces, base classes), Registration class that helps with basic setup
• Backend.Cron.Hangfire - containing implementation base on Hangfire https://www.hangfire.io/
• Backend.Cron.Tests - nice to have with test to main mechanism
• Backend.Cron.Hangfire.Tests - nice to have with tests to hangfire implementation

3. In Sample directory create new folder: Cron and setup there at least basic sample project of the Backend.Cron with Hangfire usage (suggested name Backend.Cron.Hangfire.Sample

Use Identity projects a reference how to setup .csproj files and code structure.

Add better looking UI

Any quick startup guide

As I saw in the docks, there is no quick startup guide.
I was developing the same thing before saw this framework, I want to try but template is in dotnet 2.2 an obsolete one; I updated packages but there are some obsolete reference. Maybe it will be useful to update template too. This framework is a great implementation of idea, but it lacks of documentation and as a result community share.

Integration with Auth0

Could you integrate your framework with Auth0 authorization?

template mechanism to generate new Net.Core project via cmd

provide a mechanism to generate new Net.Core project form template with GoldenEye Nugets and base configuration.

Can be used:

1. https://docs.microsoft.com/en-us/dotnet/core/tutorials/create-custom-template
2. http://yeoman.io/authoring/

Prepare version of Shared.Core project for dotneCore

DDD.Sample doens't have autoregistered handlers

I noticed that the DDD.Sample project doesn't have the example of automatic registering handlers implemented with 8.0.0 Backend.Core.DDD
It can be fixed with https://github.com/oskardudycz/GoldenEye/blob/master/src/Core/Backend.Core.DDD/Registration/Registration.cs#L108

Add possibility to register handlers and other classes with desired scope

AddAll method of Repository is not working

[Question][Improvement] Add possibility to extend MartenDocumentRepository

I'm using MartenDocumentRepository ->
I need to extend the AddAsync to make validation for the argument (in my opinion this is the best place to do it)

Can we make a possibility to do it with the next release?

Add 4.5.2 framework to build options

Check if default configuration is setting Frontend project to use https

Create github.io project page

Add possibility to add navigation property to users

Add better error logging in backend and frontend

Make Modules Ninject free and split that to separate project

Backend.Core-Service

Please add interfaces to base service class.

Add base tests project

Add Identity Server

Add possibility to audit entity

Add possibility to define includes for all queries in ReadonlyRepositoryBase

Implement Cap for outbox pattern

Hi nice work here
can you explain how to add Cap before publishing event to the message broker to enable outbox pattern in your code?
I assume it has to be added in your IExternalEventProducer to publish in Cap instead of Kafka the Cap send it to Kafka after persist it into database but don't have any idea where to consume it, if you don't mind give me some guide
Thanks in advance

Extract validation core classes to separate project

Add Swagger

Swagger Schema mostly empty

I started the default template and realised that the Swagger UI does not show the Model details of e.g. Post Issue. Reason is probably, that they are defined with Property getters only..

public string Title { get; }

Not sure if there is a good solution but I changed the TargetFramework to net5.0 and then we can use the new init operator which seams to work...

public string Title { get; init; }

Not sure if the project should be limited that hard, though

Prepare version of Backend.Core project for dotneCore

Prepare version of Backend.Core.WebApi project for dotnetCore

Refactor DataContexts

1. Make DataContexts EF free
2. Prepare version of EF Data context in separate project

Setup AppVeyors builds

Netcore3.1 capability

GoldenEye.Backend.Core.WebApi.Modules contains reference to obsolete IHostingEnvironment.

Add generic parameter to service with repository type

Migrate Shared.Core to portable

Move:

• Ninject
• Fluent Validation.NET
• Resources
• DataAnnotations
• etc.
  To separate project

Move frontend javascript project to separate project

Move core classes from Joomanji

Add better top menu and routing mamangement

Login View Model is routing to TaskList not default view after logging

Add async methods to repositories

Add netCore version os Shared.Core

POST/Issues doesn't return something

I just saw, that the POST to create a new issue does not return the generated Issue. I understand that from a CQRS perspective this is ok-ish, but from a Frontend Developers perspective it does not make sense to create a new issue and then not getting the created resources. So I wanted to change it like that:

var issueId = await commandBus.SendAsync(command);
return Ok(await queryBus.SendAsync<GetIssue, IssueView>(new GetIssue(issueId)));

or maybe like this

await commandBus.SendAsync(command);
return Ok(await queryBus.SendAsync<GetIssue, IssueView>(new GetIssue(command.Id)));

I read some articles explaining that the second concept might be ok, what do you think?

Add 4.6 framework to build option

Move DBContext save changes handler to singleton class

Add Sample Webapi project

Add DDD core project