LotMaster Backend

Welcome to the API and Backend Implementation readme for the LotMaster System! This document provides comprehensive information about the backend architecture and implementation details of the LotMaster parking management system. 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 LotMaster Frontend repository. The frontend repository contains the user interface and interacts with the backend API to provide a seamless parking management experience.

Table of Contents

• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
  • Running the Application
• API Documentation

Features

LotMaster offers a wide range of capabilities to enhance your parking lot management, including:

• Dashboard: A centralized dashboard that provides an overview of the parking lot, including occupancy status, available parking spaces, and revenue information.
• Effortless Parking Sessions: Initiate and terminate parking sessions with ease, ensuring accurate calculation of duration and fees.
• Streamlined Vehicle Management: Register and update vehicle information, including license plates and owner details, for efficient tracking.
• User-Friendly Interface: Enjoy a sleek and intuitive user interface that simplifies the parking management process for both owners and customers.
• Real-Time Monitoring: Gain complete visibility into parking lot operations, monitor occupancy, and control the allocation of parking spaces.
• Automated Billing: Generate receipts and invoices for completed parking sessions, enabling seamless payment processing.
• Customization Options: Tailor the Parking Management System to meet the unique needs of your parking facility, with configurable settings and parameters.

Technologies Used

Getting Started

Follow the instructions below to get the parking management system backend up and running on your local machine.

Prerequisites

• 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)

Installation

1. Clone this repository to your local machine using:

   git clone https://github.com/bouchraakl/ParkingManagerBackend.git
   

2. Open the project in your Java IDE (e.g., IntelliJ IDEA).

Configuration

1. Configure the database connection properties in the application.properties file. Provide the necessary details such as database URL, username, and password.

2. If required, modify any other application-specific configurations in the application.properties file.

Running the Application

1. Build the project to download dependencies and compile the code.
2. Run the application using your IDE's run or debug configuration.
3. Once the application is running, you can test the API endpoints using Postman or any other API testing tool.

API Documentation

For detailed API documentation and examples, please refer to the API Documentation file on wiki.

Socials