Installation
Status and prerequisites
Section titled “Status and prerequisites”EventLoom 0.1.0-alpha.0 targets .NET 10 and is available from NuGet.
Because it is pre-release, APIs and persistence contracts may change before the
first stable release.
You need:
- the .NET SDK specified by the repository’s
global.json; - one storage backend:
- PostgreSQL 17+ for distributed relational deployments;
- MongoDB 8+ configured as a replica set or behind
mongosfor distributed document-store deployments; - SQLite for local, embedded, test, or controlled single-process scenarios;
- Docker when running PostgreSQL or MongoDB Testcontainers tests, or the Aspire-hosted Ordering API sample;
- pnpm only when building the documentation site.
Install EventLoom
Section titled “Install EventLoom”Install the ASP.NET Core application package and exactly one provider.
PostgreSQL
Section titled “PostgreSQL”dotnet add package EventLoom.AspNetCore --version 0.1.0-alpha.0dotnet add package EventLoom.EntityFrameworkCore.PostgreSql --version 0.1.0-alpha.0MongoDB
Section titled “MongoDB”dotnet add package EventLoom.AspNetCore --version 0.1.0-alpha.0dotnet add package EventLoom.MongoDb --version 0.1.0-alpha.0MongoDB must run as a replica set. Use MongoDB has a local setup and a complete quick start.
SQLite
Section titled “SQLite”dotnet add package EventLoom.AspNetCore --version 0.1.0-alpha.0dotnet add package EventLoom.EntityFrameworkCore.Sqlite --version 0.1.0-alpha.0The provider package brings in EventLoom.Hosting and EventLoom.Storage
transitively. Application code that injects EventStore,
AggregateRepository<TAggregate, TId>, ProjectionAdministration, or
OutboxAdministration uses the EventLoom.Storage namespace.
Choose a provider
Section titled “Choose a provider”| Scenario | Provider | Notes |
|---|---|---|
| Local development, tests, embedded app, one controlled process | SQLite | EF Core provider, no distributed correctness. |
| Distributed relational production deployment | PostgreSQL | EF Core provider, schemas supported, safe multi-instance workers. |
| Distributed document-store deployment | MongoDB | Direct MongoDB.Driver provider, requires replica set or mongos. |
All built-in providers support projections, snapshots, the outbox, and units of work. Only PostgreSQL and MongoDB are supported for multi-instance deployment. See Storage providers for the full matrix.
Build from source
Section titled “Build from source”Use a repository checkout when contributing to EventLoom itself. From the repository root:
dotnet restore EventLoom.slnx --locked-modedotnet build EventLoom.slnx --configuration Release --no-restoredotnet run --project tests/EventLoom.UnitTests --configuration Release --no-builddotnet run --project tests/EventLoom.EntityFrameworkCore.UnitTests --configuration Release --no-builddotnet run --project tests/EventLoom.EntityFrameworkCore.Sqlite.IntegrationTests --configuration Release --no-buildTESTCONTAINERS_RYUK_DISABLED=true \ dotnet run --project tests/EventLoom.EntityFrameworkCore.PostgreSql.IntegrationTests --configuration Release --no-buildTESTCONTAINERS_RYUK_DISABLED=true \ dotnet run --project tests/EventLoom.MongoDb.IntegrationTests --configuration Release --no-buildpnpm --dir docs buildThe Testcontainers environment variable is needed only on Docker Desktop setups where the Ryuk resource-reaper image cannot run. Do not set it globally without arranging normal container cleanup.
Next, build your first aggregate.