Backend Skeleton

Quickstart

1. Create .env file and fill with the "REQUIRED" variables from .env.xmpl
2. npm ci
3. npm run start

Suggested Project Layers

As long as the application is small, there's no need to add extra layers.
However, if necessary, it is recommended to choose from the list below.

This layers designed to maintain structure as it scales and organized by levels.

• By convention, higher-level layers must not be imported into lower-level ones.
• Additionally, layers on the same level should not import each other.

* Exists by default

└── *apis/ - contain controllers, dtos
└── features/ - contain specific feature logic
└── *services/ - contain general processing logic
└── stores/ - Repository pattern implementation - api for stores (e.g. DB)
└── contracts/, drivers/ - interfaces for external systems
└── helpers/, *config/, *entities/ - the lowest level or independent layers

Healthcheck

/health

{
  "status": "OK",
  "port": 3000,
  "logLevel": "info"
}

Swagger

/swagger