Merge pull request #31 from jp-ryuji/rename-repo-v2

Rename repo v2

Author: jp-ryuji

README.md

@@ -1,18 +1,29 @@
-# go-ddd
+# go-arch-patterns
 
-This repository showcases the Ports and Adapters architectural pattern (also known as Hexagonal Architecture) and Domain-Driven Design (DDD) methodology, with a focus on fundamental concepts such as value objects. For more details about the software architecture, see [Software Architecture](docs/software_architecture.md).
+This repository demonstrates various architectural patterns and design principles for building scalable backend systems in Go. The codebase showcases architectural patterns, database design techniques, and SaaS-specific implementations through a practical car rental platform example.
 
-The system represents a SaaS platform for car rental companies. For more details about the system, see [Entity Relationship Diagram](docs/er-diagram.md).
+For more details about the architecture, see [Software Architecture](docs/software_architecture.md).
+For the data model and relationships, see [Entity Relationship Diagram](docs/er-diagram.md).
 
 ## Key Implementation Examples
 
 This repository demonstrates the following software engineering concepts:
 
+### Domain-Driven Design & Architecture
+
 - **Value Object**:
   - *Definition*: See [Email value object](internal/domain/model/value/email.go) with [tests](internal/domain/model/value/email_test.go)
   - *Usage*: See [Individual entity](internal/domain/model/individual.go) using the Email value object
+
+### Database Design Patterns
+
 - **Class Table Inheritance**: See [Renter model](internal/domain/model/renter.go) as the base class with [Company](internal/domain/model/company.go) and [Individual](internal/domain/model/individual.go) as specialized subclasses
 
+### SaaS & Microservices Patterns *(Coming Soon)*
+
+- **PostgreSQL Row-Level Security**: Multi-tenant data isolation
+- **Outbox Pattern**: Reliable event publishing for distributed systems
+
 ## Documentation
 
 Find specific documentation in the [docs/](docs/) folder:

docs/installation_guide.md

@@ -3,8 +3,8 @@
 ## Clone the repository
 
 ```bash
-git clone https://github.com/jp-ryuji/go-ddd.git
-cd go-ddd
+git clone https://github.com/jp-ryuji/go-arch-patterns.git
+cd go-arch-patterns
 ```
 
 ## Set up environment variables with direnv
@@ -97,7 +97,7 @@ docker compose down
 You can access the PostgreSQL database using the following command:
 
 ```bash
-PGPASSWORD=$POSTGRES_PASSWORD docker exec -it go-ddd-postgres-1 psql -U $POSTGRES_USERNAME -d $POSTGRES_DBNAME
+PGPASSWORD=$POSTGRES_PASSWORD docker exec -it go-arch-patterns-postgres-1 psql -U $POSTGRES_USERNAME -d $POSTGRES_DBNAME
 ```
 
 This command uses the environment variables loaded by direnv to connect to the database.

docs/software_architecture.md

@@ -50,7 +50,7 @@ Structure:
 
 ## Go `internal` Directory
 
-The `internal` directory is a special directory in Go that restricts access to its contents. Only code within the same module (in this case, `go-ddd`) can import packages from `internal` directories. This prevents other projects from importing and depending on our internal implementation details, which helps maintain a clean public API and allows us to change internal implementations without breaking external dependencies.
+The `internal` directory is a special directory in Go that restricts access to its contents. Only code within the same module (in this case, `go-arch-patterns`) can import packages from `internal` directories. This prevents other projects from importing and depending on our internal implementation details, which helps maintain a clean public API and allows us to change internal implementations without breaking external dependencies.
 
 In this project, all core business logic, domain models, use cases, and infrastructure implementations are placed under the `internal` directory to enforce this encapsulation and prevent accidental exposure of internal details as part of the public API.
 

go.mod

@@ -1,4 +1,4 @@
-module github.com/jp-ryuji/go-ddd
+module github.com/jp-ryuji/go-arch-patterns
 
 go 1.25.0
 

internal/domain/model/factory/company.go

@@ -3,8 +3,8 @@ package factory
 import (
 	"time"
 
-	"github.com/jp-ryuji/go-ddd/internal/domain/model"
-	"github.com/jp-ryuji/go-ddd/internal/pkg/id"
+	"github.com/jp-ryuji/go-arch-patterns/internal/domain/model"
+	"github.com/jp-ryuji/go-arch-patterns/internal/pkg/id"
 )
 
 // NewCompany creates a new Company for testing purposes

internal/domain/model/factory/individual.go

@@ -4,9 +4,9 @@ import (
 	"time"
 
 	"github.com/aarondl/null/v9"
-	"github.com/jp-ryuji/go-ddd/internal/domain/model"
-	"github.com/jp-ryuji/go-ddd/internal/domain/model/value"
-	"github.com/jp-ryuji/go-ddd/internal/pkg/id"
+	"github.com/jp-ryuji/go-arch-patterns/internal/domain/model"
+	"github.com/jp-ryuji/go-arch-patterns/internal/domain/model/value"
+	"github.com/jp-ryuji/go-arch-patterns/internal/pkg/id"
 )
 
 // NewIndividual creates a new Individual for testing purposes

internal/domain/model/factory/renter.go

@@ -3,8 +3,8 @@ package factory
 import (
 	"time"
 
-	"github.com/jp-ryuji/go-ddd/internal/domain/model"
-	"github.com/jp-ryuji/go-ddd/internal/pkg/id"
+	"github.com/jp-ryuji/go-arch-patterns/internal/domain/model"
+	"github.com/jp-ryuji/go-arch-patterns/internal/pkg/id"
 )
 
 // NewRenter creates a new Renter for testing purposes

internal/domain/model/factory/tenant.go

@@ -3,8 +3,8 @@ package factory
 import (
 	"time"
 
-	"github.com/jp-ryuji/go-ddd/internal/domain/model"
-	"github.com/jp-ryuji/go-ddd/internal/pkg/id"
+	"github.com/jp-ryuji/go-arch-patterns/internal/domain/model"
+	"github.com/jp-ryuji/go-arch-patterns/internal/pkg/id"
 )
 
 // NewTenant creates a new Tenant for testing purposes

internal/domain/model/individual.go

@@ -6,7 +6,7 @@ import (
 	"github.com/aarondl/null/v9"
 	"github.com/oklog/ulid/v2"
 
-	"github.com/jp-ryuji/go-ddd/internal/domain/model/value"
+	"github.com/jp-ryuji/go-arch-patterns/internal/domain/model/value"
 )
 
 // Individuals is a slice of Individual

internal/domain/model/individual_test.go

@@ -5,7 +5,7 @@ import (
 	"time"
 
 	"github.com/aarondl/null/v9"
-	"github.com/jp-ryuji/go-ddd/internal/domain/model/value"
+	"github.com/jp-ryuji/go-arch-patterns/internal/domain/model/value"
 	"github.com/stretchr/testify/require"
 )