https://github.com/neemiassgc/contact-manager-api

A Web API to manage contacts with intuition to demostrate CRUD operations.
https://github.com/neemiassgc/contact-manager-api

Last synced: 8 months ago
JSON representation

A Web API to manage contacts with intuition to demostrate CRUD operations.

• Host: GitHub
• URL: https://github.com/neemiassgc/contact-manager-api
• Owner: neemiassgc
• License: mit
• Created: 2023-11-24T05:36:40.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-07T15:37:06.000Z (11 months ago)
• Last Synced: 2024-11-07T16:36:30.202Z (11 months ago)
• Language: Java
• Size: 387 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[README in en-US :us:](https://github.com/neemiassgc/contact-manager-api/blob/main/README_en-US.md)

# Contact Manager API

Uma API Rest multiusuário, testada e documentada para gerenciar contatos com o propósito de demonstrar operações CRUD.

![GitHub commit activity](https://img.shields.io/github/commit-activity/t/neemiassgc/contacts-manager-api)

![Tests](https://img.shields.io/badge/Tests-75-blue)

![Core language](https://img.shields.io/badge/Language-Java-blue)

![Core framework](https://img.shields.io/badge/Framework-Spring%20Boot-6DB33F?logo=spring-boot)

![Core build](https://img.shields.io/badge/Build-Gradle-02303A?logo=gradle)

![Postgres provider](https://img.shields.io/badge/Postgres-Supabase-3FCF8E?logo=supabase)

![Authentication](https://img.shields.io/badge/Authentication-Oauth2-EB5424)



    



![Deployment on Cloud](https://img.shields.io/badge/Deployment-Google%20Cloud-4285F4?logo=google%20cloud)



    



### Destaques :sparkles:

* Spring Boot + Spring Security integrado com Oauth2 atuando como servidor de recursos

* Spring Data JPA com Hibernate

* Postgres em nuvem fornecido pelo Supabase

* Multiusuário

* Documentada com Swagger ([link para documentação](https://mythic-guild-431115-g2.uc.r.appspot.com/swagger-ui/index.html))

* Imagem Docker no [Docker Hub](https://hub.docker.com/r/k4mek/contact-manager)

* Implantada no Google Cloud App Engine

### Diagrama do Banco de dados :page_facing_up:



### Demostração :fire:

Visite o projeto [Contact Manager UI](https://github.com/neemiassgc/contact-manager-ui) que cria uma interface Web para usar esta API.

### Test :test_tube:

Para executar os tests, é necessário um banco de dados Postgres. Para fazer isso, com o repositório já clonado, entre na raiz do projeto e execute o seguinte comando docker:

```bash

docker compose -f docker/postgres.yml up -d

```

Então use Gradle para executar os tests:

```bash

./gradlew test

```

### Execute localmente usando docker :cyclone:

Basta apenas usar o seguinte comando ```docker compose``` na raiz do projeto para ter a aplicação rodando:

```bash

docker compose -f docker/app.yml up -d

```

Depois disso, a API pode ser acessado em http://localhost:8080. Obs: Um token JWT é necessário para acessar a API.

### Licença :memo:

Esse projeto está sob a Mit License