Git Product home page Git Product logo

parking-lot-api's Introduction

parking-lot-api

Get Started

Ensure Poetry is installed.

Then, in the root directory, install dependencies, set up the SQLite database, and load fixtures data:

poetry install
poetry shell
python manage.py migrate
python manage.py loaddata vehicles.json parking_lots.json spots.json

Run the app:

python manage.py runserver

Documentation

Docs

Key Endpoints

  • Tell us how many spots are remaining:
    • /api/parking-lots/1/spots/?occupied=false
    • Rely on the count field
  • Tell us when the parking lot is full:
    • /api/parking-lots/1/spots/?occupied=false
    • Full if count is zero
  • Tell us how many spots vans are taking up
    • /api/parking-lots/1/spots/?vehicleType=van
  • Take in a vehicle to park
    • /api/vehicles/{license_plate}/park/
    • In POST data, include: parking_lot ID (int) and vehicle_type ("car", "motorcycle", or "van")
    • Does not require creating the vehicle prior to parking
  • Remove a vehicle from the lot
    • /api/vehicles/{license_plate}/remove/

Test

In the Poetry shell, run:

python manage.py test

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.