/api

Aplicação API REST + API GraphQL.

Primary LanguageTypeScriptMIT LicenseMIT

api

Ambientes

Desenvolvimento

CI/CD Development

# Link
1 https://dev.ladesa.com.br/api
2 https://luna.sisgha.com/api

Clientes do ambiente de desenvolvimento

  • NPM / JavaScript

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

    npm i @ladesa-ro/api-client-fetch@alpha

Produção

CI/CD Production

# Link
- não disponível

Clientes do ambiente de produção

  • NPM / JavaScript

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

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

Configuração Local

Obter o código fonte do projeto

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

api-service

cd api-service

Serviços do api-service/.devops/development/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.

dev-setup

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

dev-up

make dev-up; # Inicia os containers docker.

dev-shell

make dev-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:

    npm install;
    npm run start:dev;

dev-down

make dev-down; # Para todos os containers.

dev-cleanup

make dev-cleanup; # Para todos os containers e remove os containers e volumes associados.

dev-logs

make dev-logs; # Mostra os registros dos containers

Licença

MIT - Ladesa e Colaboradores, 2024.

MIT - Gabriel R. Antunes, 2024.