malikwahab/parking-system

Parking System API using django

Parking System

Parking System API to manage car parking in parks. Handles fee calculation and provides endpoint to make payment.

Installation

Clone the repo

clone with ssh, use
git clone git@github.com:malikwahab/parking-system.git

# clone with https, use
git clone https://github.com/malikwahab/parking-system.git

After cloning, create a virtual environment and install the requirements. For Linux and Mac users:

$ cd parking-system
$ virtualenv -p python3.6 venv
$ source venv/bin/activate
$ pip install -r requirements.txt

If you are on Windows, then use the following commands instead:

$ virtualenv -p python3 venv
$ venv\Scripts\activate
(venv) $ pip install -r requirements.txt

Perform migrations

python manage.py migrate

Start Server

python manage.py runserver

Testing

To run the tests for the app, and see the coverage, run

python manage.py test

Usage

This Application uses browsable API. To get started visit the home url

API schema

Get a swagger documentation of the API

GET /schema

Create a park

POST /park

{
  "name": "string",
  "maximum_no_cars": 0,
  "tenants": [
    "string"
  ]
}

Get all parks

GET /park

Get a park

GET /park/{id}

Edit a park

PUT /park/{id}

{
  "name": "string",
  "maximum_no_cars": 0,
  "tenants": [
    "string"
  ]
}

Delete a park

DELETE /park/{id}

Get park payment details

Retrive the fee paid and the outstanding ticket fees This endpoint accept a query param days that specify the number of days back to get payment for, if not specified, the all time payment details will be returned

GET /park/{park_id}/payment-details?days=1

Get all parking tickets in a park

GET /park/{park_pk}/parkingtickets/

Create a parking ticket

POST /park/{park_pk}/parkingtickets/

{
  "plate_number": "string",
  "park": "string",
  "tenant": "string"
}

Get a parking ticket

GET /park/{park_pk}/parkingtickets/{id}/

Edit a parking ticket

PUT /park/{park_pk}/parkingtickets/{id}/

{
  "plate_number": "string",
  "park": "string",
  "tenant": "string"
}

Delete a parking ticket

DELETE /park/{park_pk}/parkingtickets/{id}/

Make payment for a parking ticket

POST /pay-ticket/{ticket_id}/
{
    "fee_paid": 0
}

Exit a park

Successful if all payment has been made, fail otherwise

GET /exit/{ticket_id}/

Create a tenant

POST /park/{park_pk}/tenants/

{
  "name": "string",
  "parks": [
    "string"
  ]
}

Get all tenants

GET /park/{park_pk}/tenants/

Get a tenant

GET /park/{park_pk}/tenants/{id}

Edit a tenant

PUT /park/{park_pk}/tenants/{id}/

Delete a tenant

DELETE /park/{park_pk}/tenants/{id}/