CodeKey API - Backend del Proyecto

Tabla de contenido

• Tabla de contenido
• Cómo contribuir
  • Configurar el entorno de desarrollo
  • API Endopoints
  • Pull Requests

Cómo contribuir

Configurar el entorno de desarrollo

Este Proyecto utiliza yarn como gestor de dependencias

1. Manejador de paquetes. Si no tienes yarn instalalo globalmente.

npm install -g yarn

2. Asegurate de tener Nest CLI instalado.

# npm
npm install -g @nestjs/cli

# o yarn
yarn global add @nestjs/cli

3. Clonar el repositorio.

git clone https://github.com/SebasDev807/CodeKey-api.git

4. Instalar dependencias.

cd CodeKey-api
yarn install

5. Levanta la base de datos.

  docker-compose up -d

6. renombra .env.template a .env

7. Llena las variables de entorno de .env

8. Ejecuta la aplicación en desarrollo.

  yarn start:dev

9. Llenar la base de datos(Ejecutar la semilla) > Advertencia:: Solo ejecutar una vez

  http://localhost:3000/api/v1/seed

API Endpoints

Accede al siguiente url para visualizar la documentación

http://localhost:3000/api

Documentación de Nest

Documentación oficial de Nest