Skip to content

Latest commit

 

History

History
54 lines (47 loc) · 2.7 KB

README_en-US.md

File metadata and controls

54 lines (47 loc) · 2.7 KB

README in pt-br 🇧🇷

Contact Manager API

A multi-user, tested and documented Rest API for managing contacts for the purpose of demonstrating CRUD operations.

GitHub commit activity Tests Core language Core framework Core build Postgres provider Authentication Deployment on Cloud

Destaques ✨

  • Spring Boot + Spring Security integrated with Oauth2 acting as a resource server
  • Spring Data JPA + Hibernate
  • Postgres on cloud provided by Supabase
  • Multiuser
  • Documented with Swagger (link para documentação)
  • Docker image on Docker Hub
  • Deployed on Google Cloud App Engine

Database diagram 📄

Demo 🔥

Visit the project Contact Manager UI which creates a Web UI to use this API.

Test 🧪

To run the tests, a Postgres database is required. To do this, with the repository already cloned, go to the root of the project and run the following docker command:

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

Then use Gradle to run the tests:

./gradlew test

Run locally using Docker 🌀

Just use the following command docker compose in the root of the project to have the application running:

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

After that, the API can be accessed at http://localhost:8080. Note: A JWT token is required to access the API.

License 📝

This project is under Mit License