User Guide - JulianeMaran32/Java-with-Spring-Boot GitHub Wiki

📖 Guia de Uso

📌 Introdução

Bem-vindo ao repositório do projeto! Este documento contém informações essenciais para configurar, rodar e contribuir para o projeto.

🛠️ Pré-requisitos

Antes de iniciar, certifique-se de ter instalado:

🚀 Instalação e Configuração

1️⃣ Clonar o Repositório

$ git clone https://github.com/seu-usuario/seu-repositorio.git
$ cd seu-repositorio

2️⃣ Configuração do Banco de Dados

  • Configure o banco de dados no arquivo application.yml ou use variáveis de ambiente:
spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/seu-banco
    username: seu-usuario
    password: sua-senha
  jpa:
    hibernate:
      ddl-auto: update
  • Para rodar um banco de dados via Docker:
$ docker-compose up -d

3️⃣ Construção do Projeto

$ mvn clean install

4️⃣ Executando a Aplicação

$ mvn spring-boot:run

A aplicação estará disponível em: http://localhost:8080

📡 Documentação da API

Acesse a documentação no Swagger após iniciar a aplicação:

🧪 Rodando Testes

Para executar os testes unitários:

$ mvn test
⚠️ **GitHub.com Fallback** ⚠️