Opt/refine architecture

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **Asymmetric encryption and decryption**: Supported RSA and other asymmetric encryption algorithms for data protection.
 - **Symmetric encryption**: Supported symmetric key encryption (e.g. AES) for data protection.
 - **Hashing and signature verification**: Supported hashing algorithms (e.g. SHA-256, SHA-512) and verified signatures using asymmetric keys (RSA, ECDSA, etc.).
+- Adopted Domain-Driven Design to create a **modular, flexible and maintainable** project structure with a focus on the **domain at its core**
 
 ## [0.1.0] - TBD-TBD-TBD
 

cmd/crypto-vault-cli/crypto-vault-cli.go

@@ -13,7 +13,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	cryptography "crypto_vault_service/pkg/cryptography"
+	cryptography "crypto_vault_service/internal/infrastructure/cryptography"
 )
 
 // Encrypts a file using AES and saves the encryption key

cmd/crypto-vault-service/crypto-vault-service.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	v1 "crypto_vault_service/api/v1"
+	v1 "crypto_vault_service/internal/api/v1"
 
 	"github.com/gin-gonic/gin"
 )

docs/architecture-decision-record/ddd.md

@@ -0,0 +1,39 @@
+# Domain-driven Design
+
+Incorporating DDD as an architecture decision impacts the structure and development process of the entire application. By aligning the software architecture with the business domain, we promote a more **modular, flexible and maintainable** design. The goal is to deeply understand the domain, represent it through domain models and ensure that the application closely matches the business processes.
+
+```sh
+.
+├── cmd
+│   ├── crypto-vault-cli
+│       ├── Dockerfile
+│       ├── crypto-vault-cli.go
+│   └── crypto-vault-service
+│       ├── Dockerfile
+│       └── crypto-vault-service.go
+├── configs
+│   ├── dev.yml
+│   ├── prd.yml
+│   └── qas.yml
+├── go.mod
+├── go.sum
+├── internal
+│   ├── api
+│   │   └── v1
+│   │   └── v2
+│   │   └── ...
+│   ├── app
+│   ├── domain
+│   ├── infrastructure
+│   └── persistence
+└── test
+    ├── data
+    ├── integration
+    │   ├── domain
+    │   ├── infrastructure
+    │   └── persistence
+    └── unit
+        ├── domain
+        ├── infrastructure
+        └── persistence
+```

internal/app/.gitkeep

@@ -0,0 +1 @@
+Service impl

internal/domain/.gitkeep

@@ -0,0 +1 @@
+Domain models, service contracts 

internal/persistence/.gitkeep

@@ -0,0 +1 @@
+SQL, NoSQL queries or commands

test/integration/domain/.gitkeep

@@ -0,0 +1 @@
+Domain models, service contracts 

test/integration/infrastructure/cryptography/aes_test.go

@@ -0,0 +1 @@
+// tbd

test/integration/persistence/.gitkeep

@@ -0,0 +1 @@
+Domain models, service contracts 

test/unit/domain/.gitkeep

@@ -0,0 +1 @@
+Domain models, service contracts 

test/unit/infrastructure/cryptography/aes_test.go

@@ -0,0 +1 @@
+// tbd

test/unit/persistence/.gitkeep

@@ -0,0 +1 @@
+Domain models, service contracts