Skip to content

ladesa-ro/api

Repository files navigation

Web API Integrada

CI/CD - Release CI/CD - Generate Integrations

Ambientes

Instância Pública de Desenvolvimento: https://dev.ladesa.com.br/api.

Integrações

Cliente JavaScript

NPM Package: @ladesa-ro/api-client-fetch latest version

npm install @ladesa-ro/api-client-fetch@latest

Desenvolvimento

Obter o código fonte do projeto

git clone https://github.com/ladesa-ro/api.git
cd api

Estrutura de Pastas

./api-service

cd api-service

A pasta API service contém o código fonte do Serviço de API, que utiliza o framework NestJS no NodeJS.

Serviços do docker-compose.yml

Host Endereço Descrição Plataforma Base
ladesa-api localhost:3701 Aplicação NodeJS. docker.io/library/node:22
ladesa-api-db localhost:5432 Banco de dados postgres. docker.io/bitnami/postgresql:15

Scripts Make

O projeto conta com um arquivo make que comporta scrips destinados ao desenvolvimento da aplicação.

Visão geral dos scripts make
  • setup

    make setup;

    Configura o ambiente de deselvolvimento, como a criação da rede ladesa-net e os arquivos .env.

  • up

    make up;

    Inicia os containers da api e do banco de dados usando o docker.

  • shell

    make shell;

    Inicia os containers docker e abre o bash na aplicação node.

    • Após este processo, talvez você queira executar dentro do shell do container:

      pnpm run start:dev;
  • down

    make down;

    Encerra todos os containers.

  • cleanup

    make cleanup;

    Encerra todos os containers e remove os containers e volumes associados.

  • logs

    make logs;

    Mostra os registros dos containers

Licença

MIT © 2024 – presente, Ladesa.