EventFlow NuGet Package

# EventFlow


```
$ dotnet add package EventFlow
```

EventFlow is a basic CQRS+ES framework designed to be easy to use.

Have a look at our [getting started guide](https://geteventflow.net/getting-started/),
the [do’s and don’ts](https://geteventflow.net/additional/dos-and-donts/) and the
[FAQ](https://geteventflow.net/additional/faq/).

Alternatively, join our [Discord](https://discord.gg/QfgNPs5WxR) server to engage with the community.

Its hopefully getting a reboot to kickstart the upcoming release of v1.

## Features

* **Easy to use**: Designed with sensible defaults and implementations that make it
easy to create an example application
* **Highly configurable and extendable**: EventFlow uses interfaces for every part of
its core, making it easy to replace or extend existing features with custom
implementation
* **No use of threads or background workers**
* **MIT licensed** Easy to understand and use license for enterprise

## Versions

Development of version 1.0 has started and is mainly braking changes regarding changes
related to replacing EventFlow types with that of Microsoft extension abstractions,
mainly `IServiceProvider` and `ILogger<>`.

The following list key characteristics of each version as well as its related branches
(not properly configured yet).

* `1.x`

Represents the next iteration of EventFlow that aligns EventFlow with the standard
packages for .NET. Releases here will only support .NET Standard, .NET Core
and .NET versions 6+ going forward.

- Released
- Still development
- Not all projects migrated yet

Read the [migration guide](https://geteventflow.net/migrations/v0-to-v1/) to view the full list of breaking
changes as well as recommendations on how to migrate.

### Documentation
Version 1.x documentation has been pulled into this repository in order to have
the code and documentation closer together and have the documentation
updated in the same pull-requests as any code changes. The compiled version of the
documentation is available at https://geteventflow.net/.

### NuGet package status

- 🟢 ported
- 💚 newly added to 1.0
- 🟠 not yet ported to 1.0
- 💀 for packages that are removed as part of 1.0 (see the [migration guide](https://geteventflow.net/migrations/v0-to-v1/) for details)

Projects
- 🟢 `EventFlow`
- 🟠 `EventFlow.AspNetCore`
- 💀 `EventFlow.Autofac`
- 💀 `EventFlow.DependencyInjection`
- 🟠 `EventFlow.Elasticsearch`
- 🟠 `EventFlow.EntityFramework`
- 🟠 `EventFlow.EventStores.EventStore`
- 🟢 `EventFlow.Hangfire`
- 🟢 `EventFlow.MongoDB`
- 🟢 `EventFlow.MsSql`
- 💀 `EventFlow.Owin`
- 🟢 `EventFlow.PostgreSql`
- 💚 `EventFlow.Redis`
- 🟠 `EventFlow.RabbitMQ`
- 🟢 `EventFlow.Sql`
- 🟠 `EventFlow.SQLite`
- 🟢 `EventFlow.TestHelpers`

### Branches
- `develop-v1`: Development branch, pull requests should be done here
- `release-v1`: Release branch, merge commits are done to this branch from
`develop-v1` to create releases. Typically each commit represents a release

* `0.x` (legacy)

The current stable version of EventFlow and has been the version of EventFlow
for almost six years.

0.x versions have .NET Framework support and limited
support to the Microsoft extension packages through extra NuGet packages.

Feature and bug fix releases will still be done while there's interest in
the community.

### Branches
- `develop-v0`: Development branch, pull requests should be done here
- `release-v0`: Release branch, merge commits are done to this branch from
`develop-v0` to create releases. Typically each commit represents a release

### Documentation
Version 0.x documentation is (although a bit outdated) is live at
https://docs.geteventflow.net/.