Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Documentação

Jump to bottom
Bouchra Akl edited this page Jun 4, 2023 · 5 revisions

Primeiros Passos

Nesta seção, você encontrará os passos iniciais para começar a utilizar o GPC.

  • Requisitos do Sistema: Verifique se o seu sistema atende aos requisitos mínimos para instalação do GPC.
  • Instalação: Siga o Guia de Instalação para configurar corretamente o ambiente de desenvolvimento.
  • Configuração Inicial: Após a instalação, siga as instruções para realizar a configuração inicial do sistema.

Requisitos do Sistema

Esta seção descreve os requisitos mínimos e recomendados do sistema para o GPC. Certifique-se de que seu computador atenda a esses requisitos antes de prosseguir com a instalação ou uso do sistema.

Requisitos de Software :

  • Java Development Kit (JDK): JDK 19.0.2 ou versão mais recente.
  • Apache Maven: Versão 3.9.0 ou superior.
  • Spring Boot: Versão 3.0.4 ou superior.
  • Hibernate: Versão 6.1.4 ou superior.
  • PostgreSQL Database: Versão 15.2 ou superior.
  • Postman: Versão mais recente para testes de API.

Dependências Utilizadas :

Certifique-se de adicionar as seguintes dependências ao arquivo pom.xml do seu projeto Maven:

  • org.springframework.boot:spring-boot-starter-data-jpa
  • org.springframework.boot:spring-boot-starter-validation
  • org.springframework.boot:spring-boot-starter-web
  • org.flywaydb:flyway-core
  • org.postgresql:postgresql (Escopo de tempo de execução)
  • org.projectlombok:lombok
  • org.springframework.boot:spring-boot-starter-test
  • org.hibernate:hibernate-envers

Configuração do PostgreSQL :

Certifique-se de configurar corretamente o arquivo application.properties ou application.yml do seu projeto Spring Boot com as seguintes informações do PostgreSQL:

   spring.datasource.url=jdbc:postgresql://localhost:5432/[nome_do_banco_de_dados]
   spring.datasource.username=[usuário_do_banco_de_dados]
   spring.datasource.password=[senha_do_banco_de_dados]
   spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect

Certifique-se de substituir [nome_do_banco_de_dados], [usuário_do_banco_de_dados] e [senha_do_banco_de_dados] pelos valores adequados para o seu ambiente.

Guia de Instalação

O Guia de Instalação fornece um passo a passo detalhado para configurar o ambiente de desenvolvimento do GPC. Siga as instruções fornecidas para garantir uma instalação correta e sem problemas.

  1. Pré-requisitos: Verifique e instale todas as dependências necessárias antes de prosseguir com a instalação.

  2. Clone o Repositório: Clone este repositório em sua máquina local usando

    https://github.com/grupo09-projeto-integrador/GPC-Backend.git

  3. Configuração: Execute as etapas de configuração, incluindo a definição de credenciais e configurações de banco de dados.

  4. Compilação e Execução: Compile o código-fonte do GPC e execute o sistema em seu ambiente local.

Documentação da API

A Documentação da API fornece detalhes técnicos sobre como interagir com o GPC por meio de uma interface de programação de aplicativos (API).

Introdução

Bem-vindo à documentação da API do GPC Backend. Esta API fornece endpoints para gerenciar ativos no sistema GPC.

O objetivo desta documentação é fornecer todas as informações necessárias para entender e utilizar os recursos disponíveis na API do GPC Backend. Você encontrará detalhes sobre cada endpoint, incluindo as informações de autenticação, parâmetros esperados e exemplos de solicitações e respostas.

image
Clone this wiki locally