Welcome to the API and Backend Implementation readme for the GPC System! This document provides comprehensive information about the backend architecture and implementation details of the GPC. By leveraging Java and the Spring Boot framework, the backend offers a powerful and scalable solution for optimizing parking lot operations.
To fully utilize the LotMaster System, please make sure you have set up and run the corresponding GPC Frontend repository. The frontend repository contains the user interface and interacts with the backend API to provide a seamless parking management experience.
- Hospital Item Registration: Rotary Club members can add detailed information about donated hospital items, including descriptions, features, conditions, donation dates, and other relevant details.
- Asset Tracking: The system allows for the tracking of registered assets. Members can view detailed information for each asset, such as its category, condition, status, and description. This facilitates the control and organization of hospital items.
- Search and Filtering: The GPC system offers search and filtering capabilities that allow Rotary Club members to locate specific assets based on criteria such as condition, status, asset ID, and category name. This helps in quickly finding desired items.
- Inventory Management: The system enables members to track the available stock of hospital items, including current quantity, entry and exit dates, and storage locations. Reports: GPC generates reports to assist in Rotary management. This includes information such as a complete history of all donations made, among other relevant data.
- Notifications and Alerts: The system can send automatic notifications to Rotary Club members regarding new requests for hospital items, status updates, and other important information related to donations and inventory management.
Follow the instructions below to get the parking management system backend up and running on your local machine.
- Java Development Kit (JDK) 11 or above
- IntelliJ IDEA (or any other Java IDE of your choice)
- PostgreSQL (local installation or remote connection)
- Postman (for testing the API)
-
Clone this repository to your local machine using:
git clone https://github.com/bouchraakl/GPC-Backend.git
-
Open the project in your Java IDE (e.g., IntelliJ IDEA).
-
Configure the database connection properties in the
application.properties
file. Provide the necessary details such as database URL, username, and password. -
If required, modify any other application-specific configurations in the
application.properties
file.
- Build the project to download dependencies and compile the code.
- Run the application using your IDE's run or debug configuration.
- Once the application is running, you can test the API endpoints using Postman or any other API testing tool.
You can find the detailed project documentation on our wiki : GPC Wiki
Role | Name | |
---|---|---|
Developer | Bouchra Akl | [email protected] |
Developer | Gustavo Piegat | [email protected] |
Mentor | Giovanni Rizzato | [email protected] |
Developer | Jean Moschen | [email protected] |
Scrum Master | Vinicius Gabriel Aquino | [email protected] |