/ParkingLotManagement

API for parking lot management

Primary LanguageGoMIT LicenseMIT

Parking Lot API

codecov Go Report Card Codacy Badge

Features

  • Create Parking Lot
  • Parking Lot Status
  • Toggle Maintenance Mode
  • Park Vehicle
  • Unpark Vehicle
  • Daily Parking Report

Project Structure

.
|-- migration           # Contains migration files
|-- .env.example        # example/structure of .env file
|-- Dockerfile          # Used to build docker image.
|-- go.mode             # Define's the module's import path used for root directory
|-- go.sum              # Contains the expected cryptographic checksums of the content of specific module versions
|-- readme.md           # Explains project installation and other informations

Tools and Technology

  • Golang
  • PostgreSQL

Installation

  • Step-1: Copy/rename .env.example file as .env. Change the APP_PORT, DB_PORT, DB_NAME,DB_HOST, DB_USER, DB_PASSWORD value as per your DB and Project setup.

    For local environment, you can use the following commands to set env:

    export DB_NAME=parkingapp export DB_HOST=localhost export DB_PORT=5432

  • Step-2: Import parkingapp.sql in the database

  • Step-4: To start server run go run main.go

  • Step-5: For API collection, Import Parking Lot API.postman_collection.json in postman.