https://github.com/semih-turan/veterinary-management-system-api

The veterinary management system project provides an API through which a veterinary clinic can manage its own business. This application can be used by veterinary professionals to manage veterinarians, clients, animals and vaccinations. It also manages doctors' available days and appointments for animals.
https://github.com/semih-turan/veterinary-management-system-api

patika-dev patika-plus spring-boot veterinary veterinary-clinic-api

Last synced: about 1 month ago
JSON representation

The veterinary management system project provides an API through which a veterinary clinic can manage its own business. This application can be used by veterinary professionals to manage veterinarians, clients, animals and vaccinations. It also manages doctors' available days and appointments for animals.

• Host: GitHub
• URL: https://github.com/semih-turan/veterinary-management-system-api
• Owner: semih-turan
• License: mit
• Created: 2024-05-19T15:34:36.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T09:52:35.000Z (about 2 years ago)
• Last Synced: 2025-04-23T19:16:02.397Z (about 1 year ago)
• Topics: patika-dev, patika-plus, spring-boot, veterinary, veterinary-clinic-api
• Language: Java
• Homepage:
• Size: 470 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Veterinary Management System API

## Project Description

![](./readmeAssets/banner.png)

The veterinary management system project provides an API for a veterinary clinic to manage its operations. This application is used by veterinary staff to manage veterinary doctors, customers, animals, and vaccines. It also handles the scheduling of appointments and the management of doctors' available dates.

### Technologies

![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white) ![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white) ![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white) ![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white) ![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)

## Project Overview

The veterinary management system offers a comprehensive management solution for veterinary clinics. This project is developed using Spring Boot and PostgreSQL and is designed with a layered architecture.

### Project Features

- Management of veterinary doctors, including creation, update, viewing, and deletion.

- Management of doctors' available dates, including creation, update, viewing, and deletion.

- Management of customers, including creation, update, viewing, and deletion.

- Management of animals, including creation, update, viewing, and deletion.

- Management of vaccines applied to animals, including creation, update, viewing, and deletion.

- Scheduling of appointments with date and time, checking for availability and avoiding conflicts.

### Architecture

**Layered Architecture:** The application is developed following a layered architecture pattern.

**Dependency Injection:** Constructor injection is used for Inversion of Control (IoC) and Dependency Injection (DI).

**Exception Handling:** Custom exceptions are used for error handling, ensuring meaningful responses to API users.

**Data Transfer Objects (DTOs):** Request and response DTOs are used for API endpoints.

**Database:** Postgresql is used as the relational database, with Spring Data JPA for data access.

**API Documentation:** API endpoints are documented for easy integration and usage in swagger.

**Sample Data:** Sample data is provided in the database for testing and demonstration purposes.

### API Endpoints

The API documentation is available at [/swagger-ui/index.html](http://localhost:8080/swagger-ui/index.html#/) with Swagger UI. The documentation provides details about the API endpoints, request and response bodies, and sample requests.

![](./readmeAssets/swagger-endpoints.png)

### Project Setup and Running

1. **Clone the Repository:**

   ```git clone https://github.com/username/veterinary-management-system.git```

   ```cd veterinary-management-system```

2. **Install Dependencies:**

    ```./mvnw clean install```

3. **Configure the Database:**

Set up your PostgreSQL database and update the ```application.properties``` file.

4. **Run the Application:**

    ```./mvnw spring-boot:run```

### Sample Data

The application provides sample data for testing and demonstration purposes. The sample data is loaded using the ```SQL/veterinary.sql``` file.

### UML Diagram

![](./readmeAssets/UML.png)

### Requirements

JDK 22 or higher

Spring Boot 3.2.5 or higher

### Contribution

If you wish to contribute to the project, please create a pull request or open an issue. All contributions are welcome.

### License

This project is licensed under the MIT License. See the LICENSE file for details.

### Contact

For questions or suggestions, please contact us at semituran@gmail.com.