{"id":19145411,"url":"https://github.com/ameyjoshi0209/roommates","last_synced_at":"2026-05-04T09:34:33.880Z","repository":{"id":214012904,"uuid":"617293095","full_name":"ameyjoshi0209/Roommates","owner":"ameyjoshi0209","description":"Explore our diverse range of rental flats designed specifically for students and bachelors. Find the perfect living space to support your academic or professional pursuits with ease and transparency.","archived":false,"fork":false,"pushed_at":"2024-03-28T15:27:24.000Z","size":51725,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-22T19:42:28.423Z","etag":null,"topics":["bootstrap5","css","database-management-systems","html","javascript-library","jquery-ajax","linux-shell","php","postgresql-database","wsl-ubuntu","wsl2"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ameyjoshi0209.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-22T04:41:42.000Z","updated_at":"2024-07-25T11:20:52.000Z","dependencies_parsed_at":"2024-11-09T07:40:14.646Z","dependency_job_id":"6fe6bc6b-3b5f-4a3c-a4d0-83b2c20ae8ad","html_url":"https://github.com/ameyjoshi0209/Roommates","commit_stats":null,"previous_names":["ameyjoshi0209/project-roommates","ameyjoshi0209/roommates"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ameyjoshi0209/Roommates","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameyjoshi0209%2FRoommates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameyjoshi0209%2FRoommates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameyjoshi0209%2FRoommates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameyjoshi0209%2FRoommates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ameyjoshi0209","download_url":"https://codeload.github.com/ameyjoshi0209/Roommates/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameyjoshi0209%2FRoommates/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32601609,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T22:12:39.696Z","status":"online","status_checked_at":"2026-05-04T02:00:06.625Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap5","css","database-management-systems","html","javascript-library","jquery-ajax","linux-shell","php","postgresql-database","wsl-ubuntu","wsl2"],"created_at":"2024-11-09T07:40:05.850Z","updated_at":"2026-05-04T09:34:33.874Z","avatar_url":"https://github.com/ameyjoshi0209.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ROOMMATES\n\n [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Size](https://4.vercel.app/github/size/ameyjoshi0209/Roommates?icon=github)](src)\n[![GitHub](https://badgen.net/badge/icon/github?icon=github\u0026label)](https://github.com)\n[![Windows](https://badgen.net/badge/icon/windows?icon=windows\u0026label)](https://microsoft.com/windows/)\n[![Visual Studio Code](https://img.shields.io/badge/--007ACC?logo=visual%20studio%20code\u0026logoColor=ffffff)](https://code.visualstudio.com/)\n\n\u0026nbsp;\n## 📑 Index\n\n| **Main Section**                              | **Subsections**                                                                                                                                                                                                                      |\n|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Introduction to the System](#introduction-to-the-system)       | [Problem Definition](#problem-definition) \u003cbr\u003e [Scope of System](#scope-of-system) \u003cbr\u003e [Advantages](#advantages) \u003cbr\u003e [Disadvantages](#disadvantages)                                                                              |\n| [System Analysis](#system-analysis)        | [Requirement Analysis](#requirement-analysis) \u003cbr\u003e [Functional Requirements](#functional-requirements) \u003cbr\u003e [Performance Requirements](#performance-requirements) \u003cbr\u003e [Feasibility Study](#feasibility-study-of-the-system)        |\n| [Hardware \u0026 Software Requirements](#hardware-and-software-requirements) | —                                                                                                                                                                                                                                     |\n| [ER Diagram](#er-diagram)                  | [Data Dictionary](#data-dictionary)                                                                                                                                                                                                  |\n| [System Design](#system-design)            | [Use Case Diagram](#1-use-case) \u003cbr\u003e [Class Diagram](#2-class-diagram) \u003cbr\u003e [Activity Diagram](#3-activity-diagram) \u003cbr\u003e [Sequence Diagram](#4-sequence-diagram) \u003cbr\u003e [Collaboration Diagram](#5-collaboration-diagram) \u003cbr\u003e [Deployment Diagram](#6-deployment-diagram) \u003cbr\u003e [Component Diagram](#7-component-diagram) |\n| [User Manual](#user-manual)                | [Tenant](#user-manual-for-tenant) \u003cbr\u003e [Owner](#user-manual-for-owner) \u003cbr\u003e [Admin](#user-manual-for-admin)                                                                                                                          |\n| [Testing](#testing)                        | [Test Cases](#test-cases)                                                                                                                                                                                                            |\n| [Conclusion](#conclusion)                  | —                                                                                                                                                                                                                                     |\n| [Future Enhancement](#future-enhancement)  | —                                                                                                                                                                                                                                     |\n| [Bibliography](#bibliography)             | —                                                                                                                                                                                                                                     |\n\n\n\u0026nbsp;\n## INTRODUCTION TO THE SYSTEM\n\nWebsite for PG properties and flats for students and working\nprofessionals is the website which provides accessibility to students as\nwell as working professionals to search and rent properties according to\ntheir requirements. This system can be used to search, sort, filter and\nrent properties according to the user requirements.\n\n\u0026nbsp;\n### Problem Definition\nRenting a new property in a new place is a bewildering task for any\nindividual, especially a student or a working professional. Lack of\nproper property information and location, communication barrier between\na tenant and owner, broker lobby in particular area becomes a hurdle in\nthe way of individual. Even rent and deposit payment scheme still comes\nin an offline mode which still is a snag in the way of payment system.\n\n\u0026nbsp;\n### Scope of System\nThe contemporary system is designed to overcome previously stated\nproblems and relieve both tenant as well as owner in its own ways. The\ntenant (student or working professional) can easily search and rent\nproperty according to their requirements. The user can sort property\naccording to his/her needs so as to smoothen renting process. Also, the\npayment system will be available through the website to ease payment\naccessibility between tenant and owner.\n\n\u0026nbsp;\n### _*Advantages*_\n-   A specialized property renting website only for students and working\n    professionals.\n-   Proper communication between tenant and owner without any\n    third-party interruptions.\n-   Sorting and Filters according to user requirement to get required\n    property information without any delay.\n\n### _*Disadvantages*_\n-   Internet connection is required.\n\n\u0026nbsp;\n## SYSTEM ANALYSIS\n### Requirement Analysis\nRequirement analysis involved defining customer needs and objectives in\nthe context of planned customer use, environments and identified system\ncharacteristics to determine requirements for system functions.\n\n\u0026nbsp;\n### Functional Requirements\nThis is a necessary task, action or activity that was accomplished. The\nproposed system can:\n-   Allow the administrator to delete houses, tenants and defaulters\n    details.\n-   Allow the administrator to search for data in the database.\n-   Allow the administrator to edit data in the database.\n\n\u0026nbsp;\n#### Actor Function\n\n\u0026nbsp;\n_*Owner*_\n-   Adding information about the house\n\n\u0026nbsp;\n_*Tenant*_\n-   Search the house.\n-   Select the house they want.\n-   Rent the house.\n\n\u0026nbsp;\n_*Administrator*_\n-   Edit data in the database.\n-   Delete data in the database.\n-   Update data in the database\n-   Delete tenant and owner.\n\n\u0026nbsp;\n### Performance requirements\nThe system should respond within a short period of time. It depends on\nthe performance of the hardware environment such as RAM and\nprocessor\n\n\u0026nbsp;\n### Feasibility Study of the System\nThe feasibility study is the preliminary study that determines whether a\nproposed system project is financially, technically and operationally.\nFeasibility study is essential to evaluate the cost and benefits of the new system.\nThe alternative analysis usually includes as part of the feasibility study, identifies viable alternatives for the system design and development.\n\n\u0026nbsp;\n### Operational Feasibility\nThe system to be developed will provide accurate, active, secured service and decreases labour of workers and also it is not limited to particular groups or body. The system will easily operational, as it doesn't affect the existing organizational structure and support the current system. So the system will be operationally feasible.\n\n\u0026nbsp;\n### Technical Feasibility\nThe system to be developed by using technologically system development techniques such as PHP, Java script, CSS and PostgreSQL database without any problems and the group members have enough capability to develop the project. Our focus is to develop well organized dynamic web site that is technically efficient and effective for managing the Online Trade interaction system. Therefore, it can be concluding that the system is technically feasible.\n\n\u0026nbsp;\n### Economic Feasibility\nThe system to be developed is economically feasible and the benefit is outweighing the cost. Since this project already computerizes the existing system and more advanced than the current system reduces and change the labour force to computerize system. Reduces the cost of the material used.\n\n\u0026nbsp;\n### **Hardware and Software Requirements:**\n#### H/W Configuration (Server Side)\n- Processor - Core i3 \u0026 above\n- Speed - 2 GHz \u0026 above\n- RAM - 2 GB \u0026 above\n- Hard Disk - 500 GB \u0026 above\n\n#### Software (Server Side)\n- Operating System − Linux (Debian or Red Hat Based)\n- Server − Apache 2.4.X\n- Database − PostgreSQL\n\n#### H/W Configuration (Client Side)\n- Processor − Pentium 4 or above\n- Speed - 1.1 GHz \u0026 above\n- RAM - 1 GB \u0026 above\n- Hard Disk - 5 GB or above\n\n#### Software (Client Side) Technology\n- Operating System − Windows 7,8,10, Linux.\n- Web Browser − Google Chrome, Mozilla Firefox etc.\n\n\u0026nbsp;\n### ER Diagram\n\u0026nbsp;\n![](readme_media/image2.png)\n\n\u0026nbsp;\n### Data Dictionary\n\n#### Admin\n\n|     **Attribute**    |     **Data type**    |     **Constraints**    |\n|------------------|--------------------|--------------------|\n|     username     |     text           |     not null     |\n|     password     |     text           |                    |\n\n\u0026nbsp;\n#### Owner\n\n|     **Attribute**    |              **Data type**             |     **Constraints**    |\n|:----------------:|:----------------------------------:|:------------------:|\n|      login_id    |               integer              |       Not null     |\n|        name      |                 text               |                    |\n|       gender     |         Character varying(8)       |                    |\n|        dob       |                 date               |                    |\n|       ph_no      |                bigint              |                    |\n|       email      |                 text               |                    |\n|      username    |                 text               |       Not null     |\n|      password    |          character varying         |                    |\n|       status     |         character varying(9)       |                    |\n|       image      |                 text               |                    |\n|      Reg_time    |     Timestamp without time zone    |                    |\n\n\u0026nbsp;\n#### Tenant\n\n|     **Attribute**    |              **Data type**             |     **Constraints**    |\n|:----------------:|:----------------------------------:|:------------------:|\n|      login_id    |               integer              |       Not null     |\n|        name      |                 text               |                    |\n|       gender     |         Character varying(8)       |                    |\n|        dob       |                 date               |                    |\n|       ph_no      |                bigint              |                    |\n|       email      |                 text               |                    |\n|      username    |                 text               |       Not null     |\n|      password    |          character varying         |                    |\n|       status     |         character varying(9)       |                    |\n|       image      |                 text               |                    |\n|      Reg_time    |     Timestamp without time zone    |                    |\n\n\u0026nbsp;\n#### Property\n\n|      **Attribute**     |              **Data type**             |     **Constraints**    |\n|:------------------:|:------------------------------------:|:------------------:|\n|         p_id       |                  text                |      Not null    |\n|        p_name      |                  text                |                    |\n|        p_addr      |                  text                |                    |\n|        p_city      |                  text                |                    |\n|        p_bhk       |         character   varying(9)       |                    |\n|        p_age       |                integer               |                    |\n|       p_gender     |        character   varying(30)       |                    |\n|        p_type      |                  text                |                    |\n|        p_rent      |                Integer               |                    |\n|      p_furnish     |        character   varying(20)       |                    |\n|       p_about      |                  text                |                    |\n|       username     |                  text                |                    |\n|        status      |        character   varying(10)       |                    |\n|       p_rules      |                  text                |                    |\n|        image       |                  text                |                    |\n|      p_deposit     |                  real                |                    |\n|     Rent_status    |                boolean               |                    |\n|      p_reg_time    |     timestamp   without time zone    |                    |\n|        t_name      |                  text                |                    |\n\n\u0026nbsp;\n## SYSTEM DESIGN\n\n\u0026nbsp;\n### 1. Use Case\n\n![](readme_media/image3.png)\n\n\u0026nbsp;\n### 2. Class Diagram\n\n![](readme_media/image4.png)\n\n\u0026nbsp;\n### 3. Activity Diagram\n\n![](readme_media/image5.png)\n\n\u0026nbsp;\n### 4. Sequence Diagram\n\n![](readme_media/image6.png)\n\n\u0026nbsp;\n### 5. Collaboration Diagram\n\n![](readme_media/image7.png)\n\n\u0026nbsp;\n### 6. Deployment Diagram\n\n![](readme_media/image8.png)\n\n\u0026nbsp;\n### 7. Component Diagram\n\n![](readme_media/image9.png)\n\n\u0026nbsp;\n## USER MANUAL\n\n### User Manual for Tenant\n\n1)  Tenants must register themselves before using the system.\n    Registration process can be done by clicking on 'Sign Up' link\n    present on login page. Empty field registration is not permitted and\n    in return an error message is displayed.\n\n![](readme_media/image10.png)\n\n![](readme_media/image11.png)\n\n2)  After filling in the required information and clicking on 'Sign Up'\n    button, the newly created tenant profile will be sent for\n    verification at Admin side. If the Admin verifies and accepts the\n    newly created tenant profile, the tenant will be liable to use the\n    system. Till then a warning will keep appearing until verification.\n\n![](readme_media/image12.png)\n\n3)  Once the Admin verifies the Tenant account, the tenant can login\n    through login page.\n\n![](readme_media/image13.png){\n\n![](readme_media/image14.png)\n\n4)  After login successfully, the home page will be displayed to the\n    user and various actions can be performed by the Tenant as per\n    his/her choice.\n\n![](readme_media/image15.png)\n\n5)  Tenant can edit profile, when submitted after changing information,\n    information will be updated only upon administrative verification.\n\n![](readme_media/image16.png)\n\n![](readme_media/image17.png)\n\n6)  Tenant also can view the rented properties by him/her by clicking\n    'My Property' option in profile dropdown menu. This option shows the\n    different filters which tenant can apply to view properties as per\n    his/her convenience.\n\n![](readme_media/image18.png)\n\n![](readme_media/image19.png)\n\n### User Manual for Owner\n\n1)  Owners must register themselves before using the system.\n    Registration process can be done by clicking on 'Sign Up' link\n    present on login page.\n\n![](readme_media/image20.png)\n\n2)  Once the Admin verifies the Owner account, the owner can login\n    through login page.\n\n![](readme_media/image21.png)\n\n3)  After successful login, the Owner dashboard is visible in which all\n    properties uploaded by Owner are visible.\n\n![](readme_media/image22.png)\n\n4)  Owner can add property by clicking on 'Add Property' button. After\n    filling in all the required information property details are sent\n    for verification.\n\n![](readme_media/image23.png)\n\n![](readme_media/image24.png)\n\n5)  The owner can update property information, after updating property\n    information, the update will be verified by admin before making it\n    live.\n\n![](readme_media/image25.png)\n\n6)  Owner can update profile information, once the update has been done\n    and verified by the admin, the update will be made live.\n\n![](readme_media/image26.png)\n\n![](readme_media/image27.png)\n\n![](readme_media/image28.png)\n\n### User Manual for Admin\n\n1)  Admin must login through the login page using correct credentials\n    provided by the organization. After successful login, admin will be\n    redirected to dashboard of user management.\n\n![](readme_media/image29.png)\n\n![](readme_media/image30.png)\n\n2)  Admin can handle all requests related to profile update and profile\n    verification through notification panel which can be opened by\n    clicking button on bottom-right corner of the screen.\n\n![](readme_media/image31.png)\n\n![](readme_media/image32.png)\n\n![](readme_media/image33.png)\n\n3)  Similarly, by clicking 'Manage Property' button Admin can switch on\n    property management side to handle all verification requests related\n    to property update and property addition through notification panel\n    which can be opened by clicking button on bottom-right corner of the\n    screen.\n\n![](readme_media/image34.png)\n\n![](readme_media/image35.png)\n\n4)  Also admin can manually update or delete property as well as users\n    using options present on each card of the same.\n\n![](readme_media/image30.png)\n\n![A screenshot of a computer screen Description automatically generated\nwith low\nconfidence](readme_media/image36.png)\n\n![A screenshot of a computer Description automatically generated with\nmedium\nconfidence](readme_media/image37.png)\n\n5)  Report can be generated by clicking on 'info' button present on\n    top-right corner of the navigation bar.\n\n![A screenshot of a report Description automatically generated with\nmedium\nconfidence](readme_media/image38.png)\n\n![A screenshot of a report Description automatically\ngenerated](readme_media/image39.png)\n\n\u0026nbsp;\n## TESTING\n\n#### Testing Technique: Blackbox Technique\n\u0026nbsp;\n#### Test Cases:\n\n| **Test Case ID** |            **Test Case**           |                              **Test Scenario**                              |       **Pre-Conditions**      |                                               **Test Steps**                                              |                **Test Data**                |                          **Actual Result**                         |                         **Expected Result**                        | **Status** |\n|:-----------------------:|:-----------------------------------------:|:--------------------------------------------------------------------------------------:|:------------------------------------:|:----------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------:|:-------------------------------------------------------------------------:|:-------------------------------------------------------------------------:|:-----------------------:|\n|           TC_01         |      Login using   invalid credentials    |                 Check whether   user can login using invalid credentials               |       User must be   registered      |                        1) Enter   username     2) Enter   password     3) Click on log   in                      |     \u003cvalid   username\u003e     \u003cinvalid   password\u003e    |                 Error is   displayed regarding credentials                |                 Error is   displayed regarding credentials                |           PASS          |\n|           TC_02         |      Registering with   missing fields    |     Check whether   error arise when submitting registration form with empty fields    |                  N/A                 |                                     1) Fill the data     2) Click on sign   up                                   |                         N/A                        |     User is not   registered until all require data is filled properly    |     User is not   registered until all require data is filled properly    |           PASS          |\n|           TC_03         |           Filtering of   Property         |             Check whether   properties are filtering according to user need            |     Property must be   registered    |            1) Click on   pricing option     2) Apply require   filters     3) Click on   filter button           |                         N/A                        |           Properties are   filtered according to user requirement         |           Properties are   filtered according to user requirement         |           PASS          |\n|           TC_04         |     User update   verification require    |                Check whether   Admin receives the profile update request               |       User must be   registered      |     1). Once the   changes are requested by user check on Admin side whether request for update   is initiate    |                         N/A                        |          User profile   update request is displayed on Admin side         |          User profile   update request is displayed on Admin side         |           PASS          |\n\n\u0026nbsp;\n## CONCLUSION\n\nEffectively resolving the apartment issues is important to the buyer\\'s\nlong-term future, the Home Rental Project will be an important tool for\ncreating rental housing stability by helping tenants speak with greater\ncredibility through initiating and documenting communications and\nbuilding productive relationships with sellers. Home Rental project\nprovides buyers of specific housing associations and social sellers\nInternational Journal of Pure and Applied Mathematics Special Issue 1681\nwith a simple way to report and arrange repairs to properties. Finally,\nthe goal of the project is to create a better relationship between\ntenants and a seller which can be achieved through this project.\n\n\u0026nbsp;\n## FUTURE ENHANCEMENT\n\nIn future our project is meant to satisfy the needs of rental house\nowners. Several user-friendly interfaces have also been adopted. This\npackage shall prove to be a powerful in satisfying all the requirements\nof the users. It is with utmost faith that I present this software to\nyou hoping that it will solve your problems and encourage you to\ncontinue appreciating technology because it is meant to change and ease\nall our work that seems to be very difficult. I don\\'t mean that my\nproject is the best or that I have used the best technology available it\njust a simple and a humble venture that is easy to understand. In extent\nwe can add GPS system in build and can give live chat online option to\nusers. This project can also be extended to IOS Platform, and several\nstate Database can be included. Could also allow local business to push\ndeals/coupons within a certain geographic area.\n\n\u0026nbsp;\n## BIBLIOGRAPHY\n\n**CSS and HTML**\n\n[**https://www.w3schools.com/**](https://www.w3schools.com/)\n\n**PHP**\n\n[**https://www.javatpoint.com/php-tutorial**](https://www.javatpoint.com/php-tutorial)\n\n**POSTGRESQL**\n\n[**https://www.postgresql.org/docs/**](https://www.postgresql.org/docs/)\n\n**BOOTSTRAP**\n\n[**https://getbootstrap.com/docs/5.1/getting-started/introduction/**](https://getbootstrap.com/docs/5.1/getting-started/introduction/)\n\n**miscellaneous**\n\n[**https://stackoverflow.com/**](https://stackoverflow.com/)\n\n[**https://developer.mozilla.org/en-US/docs/Web/JavaScript**](https://developer.mozilla.org/en-US/docs/Web/JavaScript)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fameyjoshi0209%2Froommates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fameyjoshi0209%2Froommates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fameyjoshi0209%2Froommates/lists"}