README.md

Servicio de división territorial

Tabla de contenidos

• [Servicio de división territorial](#servicio-de-división-territorial
  • Tabla de contenidos
  • Descripción y contexto
  • Referencia del servicio
  • Cómo iniciar
  • Stack de desarrollo
    • Servidor
    • Base de datos
  • Autores

Descripción y contexto

Este servicio es un wrapper de la división territorial definida por la Oficina Nacional de Estadística (ONE).

Referencia del servicio

• Documentación oficial

Cómo iniciar

1. Configuración del repositorio

    # Clonar repositorio
    git clone https://github.com/opticrd/territorial-division-api.git;

2. Declarar y definir las variables de entorno

    # Crear archivo de variables de entorno
    cd territorial-division-api;
    touch .env;

    # Application
    PORT=
    API_VERSION=
    NODE_ENV=

    # Database
    DB_HOST=
    DB_PORT=
    DB_USER=
    DB_NAME=
    DB_PASSWORD=
    DB_LOGGING=

3. Instalar dependecias

    yarn

4. Correr proyecto

    npm run start:dev

Stack de desarrollo

Servidor

• Node.js
  • Nest.js Framework

Base de datos

• Postgres

Autores

Septiembre 2021

• Marluan Espiritusanto