💵 ExpenseSplitter

ExpenseSplitter is a Domain-Driven Design (DDD) implemented API, meticulously crafted in C#. This project serves as a vivid showcase of how Clean Architecture priciples can be applied, with an emphasis on creating a robust and scalable solution for managing expenses among users. The API allows users to create settlements, add participants, and manage expenses with flexible splitting options, ensuring a comprehensive expense settlement system.

🦩 Features / patterns

Bold split into: Domain, Application, Infrastructure, and Presentation layers
Domain layer: Entities, ValueObjects, DomainEvents, Domain Servies, Strongly typed IDs
Application Layer: CQRS using MediatR with ICommand, IQuery, ICommandHandler, IQueryHandler abstractions, Logging for ICommandHandler, Validators with handling middleware, Result-driven communication, Idempotent/duplicated request handling, Railway-oriented programming (showcase)
Presentation Layer: Minimal API with Swagger documentation, Trace ID middleware, Rate limiting.
Infrastructure Layer: EF Core (DbContext, Entity mapping, DB migrations, Repositories), Authentication & Authorization, Database migrations
Testing: Automated testing in CI, code coverage collection and history comparison, Architecture tests, testcontainers integration testing
CI/CD: Dependabot integration, auto weekly nuget packages updates, Trivy scanning, SonarQube static-code analysis, automatic semantic-release, docker image publishing
Docker support with docker-compose orchestration

🛹 Big picture

To let you quickly understand the domain and relationships of the project entities I decided to create a class diagram.

🗺️ Endpoints map

Method	Path	Notes
🟩 POST	/users/login
🟩 POST	/users/register
🟦 GET	/users/me
🟩 POST	/settlements	Generates invite code
🟦 GET	/settlements
🟦 GET	/settlements/{settlementId}
🟨 PUT	/settlements/{settlementId}
🟥 DELETE	/settlements/{settlementId}
🟦 GET	/settlements/{settlementId}/expenses
🟨 PUT	/settlements/join	Join using invite code
🟨 PUT	/settlements/{settlementId}/leave
🟦 GET	/settlements/{settlementId}/reimbrusement	Balances and suggested reimbrusements
🟪 PATCH	/settlements/{settlementId}/participants/{participantId}/claim
🟩 POST	/expenses
🟦 GET	/expenses/{expenseId}
🟨 PUT	/expenses/{expenseId}
🟥 DELETE	/expenses/{expenseId}

🔭 Further development ideas

Add websockets for real time updates
Currency support
Outbox pattern
Model diagram

👨🏻‍💻 Development

Start services locally

docker-compose up -d expensesplitter-db expensesplitter-idp

Create migration

dotnet ef migrations add --startup-project src/ExpenseSplitter.Api.Presentation --project src/ExpenseSplitter.Api.Infrastructure ...

The automated release is failing 🚨

🚨 The automated release from the `feature/semantic-release-cd` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the feature/semantic-release-cd branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Missing `package.json` file.

A package.json file at the root of your project is required to release on npm.

Please follow the npm guideline to create a valid package.json file.

Good luck with your project ✨

Your semantic-release bot 📦🚀

rutkowski-tomasz / expensesplitter.api Goto Github PK