README.md

Adote na Web - Backend

Este repositório implementa o backend do Adote na Web, uma plataforma dedicada a facilitar a adoção de animais e conectar ONGs, protetores independentes e potenciais adotantes.

Sobre o Projeto

O Adote na Web é uma iniciativa open-source que visa criar uma rede de apoio para animais em situação de adoção. Para mais detalhes sobre os objetivos e a descrição completa do projeto, visite o README do frontend.

Tecnologias Utilizadas

• Java 17
• Spring Boot 3.3.3
• Spring Web
• Spring Data JPA
• PostgreSQL Driver
• Lombok
• Spring Security
• Validation
• Swagger

Links Importantes

• Frontend do Projeto
• Backlog do Projeto
• Documentação (Wiki)
• Código de Conduta
• Guia de Contribuição

Configuração do Ambiente Local

1. Clone o repositório:

   git clone https://github.com/michelereginabora/adote-na-web-backend.git
   

2. Instale o JDK 17 e o Maven.
3. Configure o PostgreSQL e crie um banco de dados para o projeto.
4. Copie o arquivo application.properties.example para application.properties e configure as credenciais do banco de dados.
5. Execute o projeto:

   mvn spring-boot:run
   

Contribuindo

Este é um projeto open-source e estamos abertos a contribuições! Por favor, leia nosso Guia de Contribuição para saber como você pode participar.

Importante: Pull Requests devem ser abertas para a branch develop, não para main.

Documentação

Para informações detalhadas sobre a API e como usar este backend, consulte nossa Wiki.

Licença

Este projeto está licenciado sob a Licença MIT.

Contato

Para mais informações, entre em contato através de [email protected].