Castanha is a Service Template for helping you to build evolvable, adaptable and maintainable Event Sourcing applications. It follows the principles from the Clean Architecture book and has a Domain built on Domain-Driven Design. It is easy for you to start your new microservice based on its guidelines and patterns.
To run Castanha from source, clone this repository to your machine, compile and test it:
git clone https://github.com/ivanpaulovich/castanha.git
cd castanha/source/WebAPI/Castanha.UI
dotnet runThe implementation result of the Clean Architecture is a software that encapsulate Business Rules in Use Cases and the Enterprise Rules in Entities. Also the Use Cases are independent from details like User Interface, Data Access, Web Server or any external agency.
The Clean Architecture Diagram by Uncle Bob.
| Concept | Description |
|---|---|
| DDD | The Use Cases of the Account Balance are the Ubiquitious Language designed in the Domain and Application layers, we use the Eric Evans terms like Entities, Value Object, Aggregates Root and Bounded Context. |
| TDD | From the beginning of the project we developed Unit Tests that helped us to enforce the business rules and to create an application that prevents bugs intead of finding them. We also have more sophisticated tests like Use Case Tests, Mapping Tests and Integration Tests. |
| SOLID | The SOLID principles are all over the the solution. The knowledge of SOLID is not a prerequisite but it is highly recommended. |
| Entity-Boundary-Interactor (EBI) | The goal of EBI architecture is to produce a software implementation agnostic to technology, framework, or database. The result is focus on use cases and input/output. |
| Microservice | We designed the software around the Business Domain, having Continous Delivery and Independent Deployment. |
| Logging | Logging is a detail. We plugged Serilog and configured it to redirect every log message to the file system. |
| Docker | Docker is a detail. It was implemented to help us make a faster and reliable deployment. |
| MongoDB | MongoDB is a detail. You could create new Data Access implementation and setup it with Autofac. |
| .NET Core 2.0 | .NET Core is a detail. Almost everything in this code base could be ported to other versions. |
The only one prerequisite to run the Web API is a valid connection string to MongoDB. To help you run it without hard work follow the steps on prerequisites setup page.
You can run the Docker container of this project with the following command:
$ docker run -d -p 8000:80 \
-e modules__2__properties__ConnectionString=mongodb://10.0.75.1:27017 \
--name castanha \
ivanpaulovich/castanha:latestThen navigate to http://localhost:8000/swagger and play with de Swagger.
You can play with the latest build of Castanha.
This source code and website should be used only for learning purposes and all data will be erased weekly.