davids13/where-is-my-pet

An application for the lost & donation pets

WHERE IS MY PET

Overview

This project is to provide a platform for owners register their lovely lost pets

Techs

• Java Jakarta EE
• Hibernate
• PostgreSQL
• Wiremock
• React
• Github Actions
• Jenkins
• Nexus
• Sonarqube
• Docker
• Kubernetes
• Terraform
• Azure Cloud

About project

• Architectural Pattern: Entity-Control-Boundary pattern (ECB)
• Git Branching Strategy: Github Flow
• Coding Style: Google Java Style Guide
• Api Implementation: API First
• Project Structure:
  • root/
    • cicd/
      • .github/
      • jenkins/
    • database/
    • k8s/
    • postman/
      • collection/
      • environment/
    • spec/
    • application/
    • .gitignore
    • changelog.md
    • docker-compose.yml
    • Dockerfile
    • README.md

How to run this project

(Pre-Requisites: Docker Desktop, Maven)

- Clone the project: https://github.com/davids13/where-is-my-pet.git
- Create package: mvn clean package -DskipTests
- Run container: docker compose up --build
- Test it using curl: curl --location --request GET 'http://localhost:8080/where-is-my-pet-application/api/v1/pets'

Contributing

The easiest way to contribute is by opening an issue that contains feedback and review comments.

How to make a pull request

(Pre-Requisites: Docker Desktop, Maven, JDK17)

1 - Clone the project: https://github.com/davids13/where-is-my-pet.git
2 - Create a feature branch: e.g feature/implement-delete-action-on-crud
3 - Squash the commits
4 - Open a pull request

Links

• where-is-my-pet
• Git rebase