Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update NestJS with common modules rules #118

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lbmadesia
Copy link

comprehensive set of coding guidelines and rules specifically for building clean and maintainable APIs in a NestJS framework using TypeScript. These rules focus on establishing a consistent structure and coding standards, especially for common-based modules and features in NestJS projects.

New Key Features

NestJS-Specific Modular Structure:

Promotes a modular architecture where each API feature is encapsulated in a separate module.
Defines the structure of a common module (@app/common) that includes reusable elements like configurations, decorators, DTOs, guards, interceptors, and utility functions.
Specifies the role of the core module for application-wide functionalities, such as global exception handling, middleware, and guards.

Compodoc Integration:

Utilizes Compodoc to automatically generate documentation for public classes and methods, enhancing the codebase's transparency and maintainability.

Copy link

vercel bot commented Nov 8, 2024

@lbmadesia is attempting to deploy a commit to the Pontus Abrahamsson's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant