Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: rohit-sram
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 72.8 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

WolfLease 2.0 [![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/) [![DOI](https://zenodo.org/badge/878717868.svg)](https://doi.org/10.5281/zenodo.14027449)

[Link to Deployed Application](http://wolf-lease.s3-website.us-east-2.amazonaws.com/)

[![GitHub Workflow Status](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/django.yml/badge.svg)](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/django.yml) [![codecov](https://codecov.io/gh/NCSU-SE-Fall-24/WolfLease/branch/staging/graph/badge.svg?token=LgYrIJBlbU)](https://codecov.io/gh/NCSU-SE-Fall-24/WolfLease) [![Formatting python code](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/code_formatter.yml/badge.svg)](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/code_formatter.yml) [![Lint Python](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/main.yml/badge.svg?branch=staging)](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/main.yml) [![Schedule Testing](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/schedule-testing.yml/badge.svg)](https://github.com/NCSU-SE-Fall-24/WolfLease/actions/workflows/schedule-testing.yml)

WolfLease license WolfLease forks WolfLease stars WolfLease issues WolfLease issues-closed WolfLease pull-requests

Report Bug · Request Feature

📄 Description

![sublease1](https://github.com/subodh30/WolfLease/blob/Readme-updates/docs/image1.png?raw=true)


WolfLease is a comprehensive housing platform tailored for NCSU students seeking off-campus accommodations. Whether you’re looking to find a sublease, connect with a roommate, or secure the perfect apartment near campus, WolfLease streamlines the entire process, making your housing search easy and efficient. With features such as a user-friendly interface, detailed housing listings, secure login, and a robust database, WolfLease aims to provide students with a reliable, seamless leasing experience. Hosted on the cloud and designed with convenience in mind, WOLF Lease is the ultimate one-stop solution for NCSU’s student housing needs.

Phase 1

https://github.com/user-attachments/assets/8d99d027-1d08-459e-8477-89edda0dd540

Positioning Video

https://github.com/user-attachments/assets/693a7661-69c6-48b0-8454-a39b2cae7f69

📋 Rubric

  • Phase 1 Rubric: link <!-- - Phase 2 Rubric: link -->

🚀 Improvements

The original WolfLease lacks tons of features, users cannot login and authenticate, frontend and the UI was missing, scalable deployment via AWS...etc..

WolfLease previously also lacked essential features like a user-friendly interface, secure data management, and full CRUD functionality. To improve this, we modernized the UI/UX, added login validations, and implemented full CRUD operations, giving users greater control. We also deployed the platform to the cloud for better accessibility and integrated a database to manage data effectively, enhancing security and consistency.

With WolfLease 2.0 we solved all the problems with these improvements.

  • UI/UX Enhancement: Redesigned the user interface with a modern login page featuring validation, improving usability and security.
  • CRUD Operations: Added full CRUD functionality, allowing users to create, view, edit, and delete listings and profiles for enhanced content control.
  • Cloud Hosting: Deployed the application on AWS, enabling improved accessibility and scalability for a larger user base.
  • Login Validations: Integrated robust validation checks in the login process to enhance security and prevent unauthorized access.
  • Database Integration: Incorporated a database to manage and store user data effectively, ensuring data consistency and support for complex queries.

⚙️ Built with

🛠 Installation Guide

  1. Install Docker on your operating system.
  2. Clone the github repository at a preferable location in your system. git clone https://github.com/NCSU-SE-Fall-24/WolfLease.git cd WolfLease
  3. Run docker compose up in a new terminal.
  4. Open your browser and go to localhost:8010.
  5. Register a User
  6. Login with your login credentials and enjoy the application.

🔑 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 |

🚗 New Features Added -

  • FrontEnd Implementation
  • Modernized UI/UX
  • Login Page Validation
  • Full CRUD Operations
  • Cloud Hosting
  • Database Integration

❗ TroubleShooting and Help Guide

  1. For any issues faced while using the application, please email the detailed description and steps to reproduce the error at wolflease2@proton.me .
  2. If you are a developer, please raise an issue on github with steps to reproduce and possible source of error.
  3. Our email is monitored 24x7 and we usually respond within 1 hour. Happy Emailing :).

🍰 Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

👥 Contributors

Phase 1

Group - 79

Jap Purohit | Kenil Patel | Mihir Shah |

Owner

  • Name: Rohit Sriram
  • Login: rohit-sram
  • Kind: user

GitHub Events

Total
  • Member event: 2
  • Push event: 5
  • Create event: 4
Last Year
  • Member event: 2
  • Push event: 5
  • Create event: 4

Dependencies

.github/workflows/close_as_a_feature_request.yml actions
  • peter-evans/close-issue v1 composite
.github/workflows/code_formatter.yml actions
  • actions/checkout master composite
  • mritunjaysharma394/autoyapf v2 composite
.github/workflows/create-release.yml actions
  • rymndhng/release-on-push-action master composite
.github/workflows/django.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • codecov/codecov-action v3 composite
.github/workflows/main.yml actions
  • actions/checkout v2 composite
  • cclauss/Find-Python-syntax-errors-action master composite
.github/workflows/schedule-testing.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • codecov/codecov-action v3 composite
.github/workflows/style_checker.yml actions
  • andymckay/pycodestyle-action 0.1.3 composite
Dockerfile docker
  • python 3.13 build
docker-compose.yml docker
  • wolflease_image latest
angular/package-lock.json npm
  • 927 dependencies
angular/package.json npm
  • @angular-devkit/build-angular ^18.0.2 development
  • @angular/cli ^18.0.2 development
  • @angular/compiler-cli ^18.0.0 development
  • @types/jasmine ~5.1.0 development
  • jasmine-core ~5.1.0 development
  • karma ~6.4.0 development
  • karma-chrome-launcher ~3.2.0 development
  • karma-coverage ~2.2.0 development
  • karma-jasmine ~5.1.0 development
  • karma-jasmine-html-reporter ~2.1.0 development
  • typescript ~5.4.2 development
  • @angular/animations ^18.0.0
  • @angular/common ^18.0.0
  • @angular/compiler ^18.0.0
  • @angular/core ^18.0.0
  • @angular/forms ^18.0.0
  • @angular/platform-browser ^18.0.0
  • @angular/platform-browser-dynamic ^18.0.0
  • @angular/router ^18.0.0
  • axios ^1.7.2
  • bootstrap ^5.3.3
  • bootstrap-icons ^1.11.3
  • dayjs ^1.11.11
  • jquery ^3.7.1
  • ngx-bootstrap ^12.0.0
  • ngx-spinner ^17.0.0
  • ngx-toastr ^18.0.0
  • primeicons ^7.0.0
  • primeng ^17.18.0
  • rxjs ~7.8.0
  • tslib ^2.3.0
  • zone.js ~0.14.3
angular/yarn.lock npm
  • 855 dependencies
requirements.txt pypi
  • Django ==5.1.2
  • asgiref ==3.8.1
  • coverage ==7.6.4
  • django-cors-headers ==4.6.0
  • djangorestframework ==3.15.2
  • mysqlclient ==2.2.5
  • sqlparse ==0.5.1