DGII RNC ― API

Contents

• Overview
• Commands
• Database
  • Migrations
• Installation
• Running the API
• How to contribute
• License

Overview

An Open-source Community-driven API for the National Taxpayer Registry (RNC) of the Dominican Republic.

Created using Nest.

Commands

The DGII RNC API uses two commands:

• download-rnc-file: downloads the DGII RNC zip file that will be processed by the API.

  To run the download-rnc-file command, you can use:

  npm run download-rnc-file
  # which executes the shell command: `ts-node ./src/cli.ts download-rnc-file`

• process-rnc-file: ingests the unzipped RNC file (txt format by sending jobs to the queue. If the API server is running, it will begin processing the jobs right away.

  To run the process-rnc-file command, you can use:

  npm run process-rnc-file
  # which executes the shell command: `ts-node ./src/cli.ts process-rnc-file`

Database

The supported relational database for this project is PostgreSQL >= 16.x.

Migrations

To run the database migrations, first build the project, and then run:

npm run migration:run

Installation

npm ci

Running the API

npm run start # development mode
npm run dev # watch mode
npm run production # production mode

How to contribute

Read the contribution guidelines.

License

The DGII RNC API is MIT licensed.