Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielmachadovasconcelos/base-event-sourcing
Base code for the creation of a event sourcing project with CQRS
https://github.com/danielmachadovasconcelos/base-event-sourcing
cqrs event-sourcing jdk17 spring-boot
Last synced: about 2 months ago
JSON representation
Base code for the creation of a event sourcing project with CQRS
- Host: GitHub
- URL: https://github.com/danielmachadovasconcelos/base-event-sourcing
- Owner: DanielMachadoVasconcelos
- Created: 2022-01-15T21:29:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-19T11:33:53.000Z (over 1 year ago)
- Last Synced: 2023-09-19T13:53:39.694Z (over 1 year ago)
- Topics: cqrs, event-sourcing, jdk17, spring-boot
- Language: Java
- Homepage:
- Size: 48.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bank Account Service
## Daniel Machado Vasconcelos
### Basic requirements (that were implemented):
* Expose endpoints to create and close a bank account;
* Expose endpoints to deposit and withdraw founds;
* The service must make use of event source and CQRS;
* The service must persist aggregate state of all bank accounts;
### Extra requirements to be done:
* Add security layer to permit only authenticated users to operate;
* Add swagger documentation to the Rest API;
* Make sure all exchanged messages are encrypted, authenticated and has schema.
---
Prerequisites
-------------
* Java JDK 17
* Maven
* Docker / Docker Compose
#### Resources
* Kafka
* Postgres
* Elasticsearch
### Tech Stack usage
**Kafka**
I used kafka as my main message broker, to communicate between other services components, that are interested in the events.
**Postgres**
This resource saves the aggregate state of my bank account. The service reduce the list of events to a single bank account database row.
**Elasticsearch**
This database saves the list of events in order, ensured by an optimistic lock.
## How to build?
Clone this repo into new project folder (e.g., `bank-account-service`).
```bash
git clone https://github.com/DanielMachadoVasconcelos/bank-account.git
cd bank-account-service
```
Start the external resources by running the docker-compose file. (It may take a while to start all resources)
```bash
docker-compose up -d
```
---
**Start individually the spring boot applications (command and query)**
Start the service (command) that expose the REST API:
```bash
cd command
mvn spring-boot:run
```
Use the following commands to open, deposit, withdraw and close a bank account:
#### To open a bank account
```bash
curl --location --request POST 'localhost:5000/api/v1/bank-accounts' \
--header 'Content-Type: application/json' \
--data-raw '{
"account_holder":"daniel.vasconcelos",
"account_type": "SAVINGS",
"opening_balance": 45.0
}'
```
#### To deposit funds to bank account
```bash
curl --location --request POST 'localhost:5000/api/v1/bank-accounts/{bank-account-id}/deposits' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 12
}'
```
#### To withdraw funds from a bank account
```bash
curl --location --request POST 'localhost:5000/api/v1/bank-accounts/{bank-account-id}/withdraws' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 7.45
}'
```
#### To close a bank account
```bash
curl --location --request POST 'localhost:5000/api/v1/bank-accounts/6a21d2c6-a7e9-42ee-a584-86dcc331aafc/close' \
--header 'Content-Type: application/json' \
--data-raw '{
}'
```
---
Start the service (query) that will aggregate the bank account events:
```bash
cd query
mvn spring-boot:run
```
### Postgres
* Access the local url (localhost:5050) in your favorite browser to verify the Postgres Database
**Use the following credentials:**
| username | password |
|---------------|--------|
| [email protected] | admin |
### Kibana
* Access the local url (localhost:5601) in your favorite browser to verify the Elasticsearch Database
**No credentials are needed:**
* Find the option 'Dev Tools' on the left menu
* Type the following command in the console:
```
GET event-store/_search
```