Tresdoce NestJS Toolkit
Archetype
Este módulo está pensada para ser utilizada en [NestJS Starter](https://github.com/rudemex/nestjs-starter), o cualquier
proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.
## Glosario
- [🥳 Demo](https://nestjs-starter.tresdoce.com.ar/v1/docs)
- [📝 Requerimientos básicos](#basic-requirements)
- [🛠️ Instalar dependencia](#install-dependencies)
- [👨💻 Uso](#use)
- [📄 Changelog](./CHANGELOG.md)
- [📜 License MIT](./license.md)
---
## 📝 Requerimientos básicos
- [NestJS Starter](https://github.com/rudemex/nestjs-starter)
- Node.js v20.19.0 or higher ([Download](https://nodejs.org/es/download/))
- YARN v1.22.22 or higher
- NPM v11.2.0 or higher
- NestJS v11.1.0 or higher ([Documentación](https://nestjs.com/))
## 🛠️ Instalar dependencia
```
npm install -S @tresdoce-nestjs-toolkit/archetype
```
```
yarn add @tresdoce-nestjs-toolkit/archetype
```
## 👨💻 Uso
Él `ArchetypeModule` es un módulo pensado para el retorno de la información básica de la aplicación para poder
realizarle un seguimiento.
```typescript
//./src/app.module.ts
import { ArchetypeModule } from '@tresdoce-nestjs-toolkit/archetype';
@Module({
imports: [
//...
ArchetypeModule,
//...
],
//...
})
export class AppModule {}
```
Para visualizar la respuesta del endpoint, basta con navegar a `/info`.
### App Information
**Schema:** `://<:port>//info`
**Example:** `http://localhost:8080/v1/info`
## 📄 Changelog
Todos los cambios notables de este paquete se documentarán en el archivo [Changelog](./CHANGELOG.md).
---
Made with ❤
