🐈 Purrgent Care 🐕

Description

This readme provides background information regarding the Purrgent Care application, how to run it locally, and access the H2 in-memory database.

💻 Application Purpose

This application provides functionality to veterinarian's offices to maintain client's information regarding their pets, their visits to the clinic, and diagnoses over time. Specific use cases will be built over time using an agile approach to continually expand functionality.

🏛 Architecture

This application is built on a controller-service-repository architecture to provide a good separation of concerns. This application uses React for the UI portion of the application. More details can be seen in the UI README. This application leverages Java Spring Boot as the back-end framework.

Patterns

• Repository pattern for data access and retrieval.
• DAO pattern (Data Access Object) for entity management.
• DTO pattern (Data Transfer Object) to decouple domain models from presentation models.

⚙️ Pre-requisites

• IDE (IntelliJ IDEA preferred)
• Github
• Bash (Windows) or Zsh (Mac) shell
• Maven CLI
• Postman
• Gnu Make (Makefile)
• Lombok
• Node
• Node Package Manager (npm)

🏗 Build the Application

## Start Backend
mvn clean install -U

## Start UI
npm start --prefix ./purrgent-care-ui

• Also see commands in makefile

▶️ Running the Application

## Start Backend
mvn spring-boot:run

• Backend alternatives: Run config or Command line

## Start UI
npm start --prefix ./purrgent-care-ui

• Also see commands in makefile

⌨️ Development Workflow

🔀 GitFlow

This project will leverage git flow for development workflow.

💾 Accessing the H2 Database Console

H2 is a light weight in-memory database that enables fast local development without the leg work of wiring up a database, schema and connection settings. The database is only accessible while the application is running and can be accessed through the built-in H2 console by URL only. Additional Documentation

🖥️ Accessing the UI

🧪 Unit Testing

This project requires unit testing as per the Definition of Done and meet code coverage requirements.

• To run all tests run:

## Run Backend tests
mvn test jacoco:report

## Run UI tests
npm test --prefix ./purrgent-care-ui

• Also see commands in makefile

🛠 Tools used in this project

• ＠ Annotations:

  • Application annotations
  • Model annotations

• 📘 Markdown

• 📫 Postman

• 📊 Jacoco

• 📝 Makefile

• 🌶 Lombok