Git Product home page Git Product logo

boilerplate_nestjs_2's Introduction

Nest Logo

NestJS Boilerplate

Este es un boilerplate para proyectos en NestJS que incluye configuración para usar variables de entorno, conexiones a bases de datos PostgreSQL y MongoDB, y configuración personalizada de Prettier.

Características

  • Módulo de Configuración: Manejo de variables de entorno con @nestjs/config.
  • Base de Datos: Configuración para conexiones a PostgreSQL y MongoDB.
  • Prettier: Configuración personalizada para mantener un estilo de código consistente.
  • Swagger: Documentación de la API con Swagger.
  • Global Pipes: Validación de datos global usando ValidationPipe.
  • Logger: Registro de actividades con el logger de NestJS.

Requisitos Previos

  • Node.js y npm instalados.
  • PostgreSQL y/o MongoDB en funcionamiento (si se van a utilizar ambas bases de datos).

Instalación

  1. Clona el repositorio:

    git clone https://github.com/tu-usuario/tu-repositorio.git
    cd tu-repositorio
  2. Instala las dependencias:

    npm install
  3. Configura las variables de entorno: Crea un archivo .env en la raíz del proyecto y añade las siguientes variables (modifícalas según tus necesidades):

    DATABASE_HOST=localhost
    DATABASE_PORT=5432
    DATABASE_USER=myuser
    DATABASE_PASSWORD=mypassword
    DATABASE_NAME=mydatabase
    
    MONGODB_URI=mongodb://localhost/
    

Uso

Desarrollo

Para iniciar la aplicación en modo desarrollo:

npm run start:dev

Formateo de Código

Para formatear tu código usando Prettier:

npm run format

Estructura del Proyecto

El proyecto está estructurado de la siguiente manera:

src/
├── app.module.ts               # Módulo principal de la aplicación
├── database/
│   ├── postgres.providers.ts   # Proveedor de conexión a PostgreSQL
│   └── mongo.providers.ts      # Proveedor de conexión a MongoDB
├── main.ts                     # Punto de entrada de la aplicación
.env                            # Variables de entorno
prettier.config.js              # Configuración de Prettier

src/app.module.ts

El módulo principal de la aplicación. Aquí se importan y configuran los módulos de configuración y de base de datos.

src/database/postgres.providers.ts

Provee la configuración para la conexión a una base de datos PostgreSQL usando TypeOrmModule.

src/database/mongo.providers.ts

Provee la configuración para la conexión a una base de datos MongoDB usando MongooseModule.

boilerplate_nestjs_2's People

Contributors

lagomarsinohs avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.