WolfLease

Description

Finding apartments on a lease can be a difficult and time-consuming task. We can sublease a room to save time, possibly rent, and enjoy the benefits of a shorter lease time. WolfLease is an application to help people find Apartments offering rooms on sublease and move in faster! WolfLease allows us to search for flats based on location, facilities, sublease start and end dates, etc.

https://user-images.githubusercontent.com/57044378/194797729-214e39d4-0f62-4468-bd49-f906de124589.mp4

• Built with

  

• Language used: Python

• Libraries used: Django

Getting started:

• Prerequisite:

  • Download Python3.8 on your system.

• Run Instructions

  To run the site locally:

  • Clone this (Wolflease) github repo.
  • Navigate to project directory.

  • Create a virtual environment:

    python -m venv project_env

  • Activate the virtual environment:

    source project_env/bin/activate

  • Build the virtual environment:

    pip install -r requirements.txt

  • Run:

    python manage.py runserver

  • Site will be hosted at: http://127.0.0.1:8000/

WolfLease Endpoints

Admin page

|HTTP Method|URL|Description| |---|---|---| |GET|http://localhost:8000/admin/ | Admin page |

Owner

|HTTP Method|URL|Description| |---|---|---| |POST|http://localhost:8000/owners | Create new Owner | |PUT|http://localhost:8000/owners/{ownerId} | Update Owner by ID | |GET|http://localhost:8000/owners | Get all Owners | |DELETE|http://localhost:8000/owners/{ownerId} | Delete Owner by ID |

Apartment

|HTTP Method|URL|Description| |---|---|---| |POST|http://localhost:8000/apartments | Create a new Apartment | |PUT|http://localhost:8000/apartments/{apartmentID} | Update Apartment by ID | |GET|http://localhost:8000/apartments | Get all Apartments | |DELETE|http://localhost:8000/apartments/{apartmentID} | Delete Apartment by ID |

Lease

|HTTP Method|URL|Description| |---|---|---| |POST|http://localhost:8000/lease | Create a new Lease | |PUT|http://localhost:8000/lease/{LeaseID} | Update Lease by ID | |GET|http://localhost:8000/lease | Get all lease | |DELETE|http://localhost:8000/lease/{LeaseID} | Delete Lease by ID |

Flat

|HTTP Method|URL|Description| |---|---|---| |POST|http://localhost:8000/flats | Create a new Flat | |PUT|http://localhost:8000/flats/{flatID} | Update Flat by ID | |GET|http://localhost:8000/flats | Get all Flats | |DELETE|http://localhost:8000/flats/{flatID} | Delete Flat by ID |

User

|HTTP Method|URL|Description| |---|---|---| |POST|http://localhost:8000/users | Create a new User | |PUT|http://localhost:8000/users/{userID} | Update User by ID | |GET|http://localhost:8000/users | Get all Users | |DELETE|http://localhost:8000/users/{userID} | Delete User by ID |

Interested

|HTTP Method|URL|Description| |---|---|---| |POST|http://localhost:8000/interests | Create a new Interest | |PUT|http://localhost:8000/interests/{interestID} | Update Interest by ID | |GET|http://localhost:8000/interests | Get all Interests | |DELETE|http://localhost:8000/interests/{interestID} | Delete Interest by ID |

Searching through Owners, Apartments, Lease, Flats, User Models

|HTTP Method|URL|Description| |---|---|---| |GET|http://localhost:8000/owners?search={email} | Search for an Owner with given email | |GET|http://localhost:8000/owners?search={contactnumber} | Search for an Owner with given contact number | |GET|http://localhost:8000/apartments?search={address} | Search for Apartments by address | |GET|http://localhost:8000/apartments?search={facilities} | Search for Apartments with different facilities of your choice | |GET|http://localhost:8000/apartments?search={owner} | Search for Apartments by owner | |GET|http://localhost:8000/lease?search={leaseenddate} | Search for Lease by end date | |GET|http://localhost:8000/lease?search={leasestartdate} | Search for Lease by start date | |GET|http://localhost:8000/flats?search={availabilty} | Search for Flats that are available | |GET|http://localhost:8000/flats?search={rentperroom} | Search for Flats by rent amount | |GET|http://localhost:8000/users?search={email} | Search for an User with given email | |GET|http://localhost:8000/users?search={contactnumber} | Search for a User with given contact number |

Roadmap

• List of Roadmap features

Team Members

Subodh Gujar

Ameya Vaichalkar

Rohan Shiveshwarkar

Kunal Patil

Yash Sonar