Modules

Modules are the building blocks of the application, encapsulating related functionality in a modular and reusable manner. Each module typically consists of controllers, DTOs, middlewares, entities, repositories, routers, services, tests, and transformers. These files work together to handle specific tasks within the component, ensuring separation of concerns and clean, maintainable code.

Overview

A modules directory typically looks like this:

└── modules/
    └── users/
        ├── entities/
        │   └── user.entity.ts
        ├── middlewares/
        │   └── user.middleware.ts
        ├── repositories/
        │   └── user.repository.ts
        ├── services/
        │   └── user.service.ts
        ├── tests/
        │   ├── user.seeder.ts
        │   ├── user.e2e.test.ts
        │   └── user.unit.test.ts
        └── use-cases/
            └── get-user/
                ├── get-user.controller.ts
                ├── get-user.response.ts
                └── get-user.use-case.ts

Naming Module Folders

When naming component folders, it is essential to maintain consistency and clarity throughout the codebase. To achieve this, follow these conventions:

1. Use the singular form of the entity or resource represented by the component (e.g., user instead of users).
2. Use kebab-case, which separates words with hyphens (e.g., news-item instead of newsItem).

By adhering to these naming conventions, developers can quickly understand the purpose of each component and navigate the codebase more efficiently. This consistency also promotes better collaboration and communication among team members, as everyone will be on the same page when referring to components.