Especificação do Ladesa

Definição de dados e entidades do Ladesa

🚀 O que você encontra aqui

Definições de Entidades

Tudo sobre as entidades do Ladesa, suas propriedades e como se relacionam.

Dados de Comunicação

Formatos e estruturas dos dados para comunicação entre sistemas.

Artefatos de Integração

Esquemas JSON, pacotes para C# (NuGet) e JavaScript/TypeScript (NPM), todos gerados automaticamente.

👽 O quê este projeto não é

Você não encontra neste repositório as informações de como consumir e integrar aos nossos serviços em si. Para isso, indicamos que você consulte a documentação Conectar — Ladesa Dev Docs.

Dessa forma, esta especificação foca em definir quais são os dados e informações pertinentes aos nossos sistemas de maneira detalhada.

🧭 Por onde começar?

Para começar a trabalhar com a Especificação do Ladesa, siga estes passos:

• Entender os sistemas do Ladesa: Consulte a documentação essencial para desenvolvedores para entender os conceitos fundamentais de nossos projetos.

• Consumir a especificação: Veja como você pode integrar as modelagens das entidades em seus sistemas, consultando a seção 💖 Utilização.

• Obter o Código-fonte: Clone o repositório e familiarize-se com a estrutura do projeto.

• Configurar o Ambiente de Desenvolvimento: Siga as instruções na seção de 🧑‍💻 Desenvolvimento Local para configurar seu ambiente de trabalho.

• Contribuir: Veja como você pode ajudar a melhorar a especificação, consultando a seção 😊 Como Contribuir.

Conteúdo

• 💖 Utilização
  • Integração C# / DotNet
    • Instalar o pacote para dotnet
    • Utilizar o pacote para dotnet
  • Integração TypeScript / JavaScript
    • Instalar o pacote para TypeScript / JavaScript
    • Utilizar o pacote para TypeScript / JavaScript
• 🧑‍💻 Desenvolvimento Local
  • Pré-requisitos
  • Obter o código-fonte
  • Instalar as dependências
  • Estrutura do projeto
  • Gerar os artefatos da especificação
  • Comandos
• 😊 Como contribuir
• 👋 Contato
• 🤝 Licença

💖 Utilização

A Especificação do Ladesa pode ser utilizada por:

• Desenvolvedores: Para criar e manter aplicações que fazem parte do ecossistema Ladesa, garantindo que os aplicativos sigam as mesmas regras de dados e integração.

• Integradores: Para desenvolver integrações entre sistemas existentes e o Ladesa, assegurando interoperabilidade e conformidade com padrões estabelecidos.

• Analistas de Sistemas: Para entender como os dados são modelados e gerenciados dentro do ecossistema Ladesa.

Integração C# / DotNet

Instalar o pacote para dotnet

dotnet add package Ladesa.Dtos

Utilizar o pacote para dotnet

• Utilização do namespace Ladesa.Dtos

using Ladesa.Dtos;

• Conversão de uma string JSON para uma instância de alguma das classes

Arquivo arquivo = Arquivo.FromJson(jsonString);

Integração TypeScript / JavaScript

Instalar o pacote para TypeScript / JavaScript

# npm
npm install @ladesa-ro/especificacao

# pnpm
pnpm add @ladesa-ro/especificacao

# yarn
yarn add @ladesa-ro/especificacao

Utilizar o pacote para TypeScript / JavaScript

import {} from "@ladesa-ro/especificacao";

🧑‍💻 Desenvolvimento Local

Para você realizar o desenvolvimento local, preparamos o guia a seguir.

Pré-requisitos

Para o desenvolvimento local, é necessário preparar o seu ambiente de trabalho para mexer com este projeto.

Preparamos dicas e tutoriais para você acerca de cada pré-requisito, basta clicar nos links para saber mais.

• Acesso à Linha de Comando;
• Git;
• Node.js + Corepack;
• dotnet.

Obter o código-fonte

O primeiro passo para o desenvolvimento local é de obter uma cópia dos arquivos deste repositório. Para isso, digite:

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

Instalar as dependências

pnpm install

Estrutura do projeto

Note

Em progresso.

Gerar os artefatos da especificação

pnpm run build

Comandos

Todos os comandos são executados a partir da raiz do projeto, em um terminal:

Comando	Ação
pnpm install	Instala as dependências.
pnpm run -w build	Gera os artefatos da especificação.
pnpm run -w code-static:fix	Correção de lint e formatação.

Outros comandos

Comando	Ação
pnpm run -w lint:check	Checa as regras do lint.
pnpm run -w lint:fix	Corrige erros resolviveis de lint.
pnpm run -w format:check	Checa as formatações dos arquivos.
pnpm run -w format:fix	Corrige as formatações inconsistêntes dos arquivos.
pnpm run -w code-static:check	Checagem de lint e formatação.

😊 Como contribuir

Este projeto é livre e de código aberto, e todos são bem-vindos para obter o código-fonte, entender, modificar, utilizar para outros fins e compartilhar!

Se você deseja contribuir para a Especificação do Ladesa, siga os passos abaixo:

1. Fork do Repositório (apenas para colaboradores externos): faça um fork do repositório para sua conta pessoal do GitHub.
2. Crie uma Branch: Crie um branch para sua contribuição, por exemplo, feat/nova-funcionalidade.
3. Faça as Alterações: Implemente suas mudanças e faça commits explicativos.
4. Pull Request: Envie um Pull Request para o branch principal do repositório original com uma descrição detalhada das suas mudanças.

Revisões e sugestões são bem-vindas. O objetivo é manter a especificação clara, útil e atualizada para todos os usuários.

👋 Contato

Se você tiver dúvidas, sugestões ou precisar de ajuda, entre em contato conosco:

• Email: em breve.
• Comunidade: Participe de discussões e interações na comunidade do Ladesa através do Ladesa Community.
• GitHub Issues: Para relatar bugs ou sugerir melhorias, utilize a seção de Issues do GitHub.

🤝 Licença

MIT © 2024 – presente, Ladesa.

---

⭐ Marque este repositório com estrela se achar útil!