diff --git a/README.md b/README.md index 0e1211217..ad84c07d8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# [your app name here] +# HousingPal CodePath WEB103 Final Project -Designed and developed by: [your names here] +Designed and developed by: Yash Patki, Chibueze Anyanwu πŸ”— Link to deployed app: @@ -10,11 +10,17 @@ Designed and developed by: [your names here] ### Description and Purpose -[text goes here] +HousingPal is a web application designed to be a one-stop-shop to find sublets/subleases, leases, and roommates aimed at college students. As the name suggests, this platform aims to ease the housing process that college students go through at the beginning of each school year due to diminishing housing options and high costs. We focus primarily on transparency and open communication between parties to streamline the entire process for everyone involved. +- **Dedicated Housing Platform** - Provide a purposeful medium to help college students secure housing without the reliance on Facebook Groups and other extraneous sources to scurry in search of housing. +- **Transparency** - Provide transparency to tenants, subtenants, and roommates by displaying costs and preferences up front to help connect interested, compatible parties. +- **Convenience** - Finding housing is stressful and very time-consuming, so our goal is to ease that process by allowing users to filter through what they are looking for, posting details, and contact each other if there's a match. ### Inspiration -[text goes here] +When speaking with each other, we had several ideas: applications for finding campus events, finding rideshares, syncing playlists between streaming services, and finding people to study within your classes. However, we decided to pursue this idea since both of us struggled due to the lack of housing during COVID-19 and experienced hardships finding roommates and leases using college-specific Facebook Groups, Discord chats, and other sources without much luck or with unnecessary troubles. + +As a result, this idea addresses a tangible issue that many college students face while allowing us to design an application based on what we would have liked to have when we were navigating the Housing process ourselves. + ## Tech Stack @@ -24,25 +30,66 @@ Backend: ## Features -### [Name of Feature 1] +### 1. Users can Create an Account + +- [ ] Users can create an account using their school email address and password. + +[gif goes here] + +### 2. Users (Tenants) can Post a Listing + +- [ ] Users can post a listing for a sublet/sublease or lease/roomate. +- [ ] Each Sublease/Lease listing includes: + - [ ] Type of listing (sublease/sublet or lease/roommate) + - [ ] Name(s) of the tenant(s) + - [ ] Preferences/Criteria for new tenant/roommate + - [ ] Location/Community + - [ ] Cost + - [ ] Lease/Sublease Duration + - [ ] Pictures of the property + - [ ] Contact information + - [ ] Other details -[short description goes here] [gif goes here] -### [Name of Feature 2] +### 3. Users (Looking for Housing) can Post Profile -[short description goes here] +- [ ] Users can post a profile for themselves if they are looking for housing. +- [ ] Each profile includes: + - [ ] Name + - [ ] Bio (age, major, etc.) + - [ ] Preferences/Criteria for housing + - [ ] Hobbies/Interests + - [ ] Budget Range + - [ ] Image of the user + - [ ] Contact information + - [ ] Other details [gif goes here] -### [Name of Feature 3] +### 4. All Users can switch between the Listings and Profiles pages -[short description goes here] +- [ ] Users can switch between the Listings and Profiles pages using the navigation bar. [gif goes here] -### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them] +### 5. Users can filter Listings and Profiles + +- [ ] Users can filter Listings and Profiles by: + - [ ] Location + - [ ] Cost + - [ ] Duration + - [ ] Preferences/Criteria + - [ ] Other details + +[gif goes here] + +### 6. Users have basic CRUD functionality for Listings and Profiles + +- [ ] Users can create, read, update, and delete Listings and Profiles. + +[gif goes here] ## Installation Instructions diff --git a/milestones/milestone1.md b/milestones/milestone1.md index a8f086378..853e2840f 100644 --- a/milestones/milestone1.md +++ b/milestones/milestone1.md @@ -6,26 +6,39 @@ This document should be completed and submitted during **Unit 5** of this course This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets. -- [ ] Read and understand all required features - - [ ] Understand you **must** implement **all** baseline features and **two** custom features -- [ ] In `readme.md`: update app name -- [ ] In `readme.md`: add all group members' names -- [ ] In `readme.md`: complete the **Description and Purpose** section -- [ ] In `readme.md`: complete the **Inspiration** section -- [ ] In `readme.md`: list all features you intend to include in your app (in future units, you will check off features as you complete them and add GIFs demonstrating the features) -- [ ] In `planning/user_stories.md`: add all user stories -- [ ] In this document, complete the **Reflection** section below +- [x] Read and understand all required features + - [x] Understand you **must** implement **all** baseline features and **two** custom features +- [x] In `readme.md`: update app name +- [x] In `readme.md`: add all group members' names +- [x] In `readme.md`: complete the **Description and Purpose** section +- [x] In `readme.md`: complete the **Inspiration** section +- [x] In `readme.md`: list all features you intend to include in your app (in future units, you will check off features as you complete them and add GIFs demonstrating the features) +- [x] In `planning/user_stories.md`: add all user stories +- [x] In this document, complete the **Reflection** section below ## Reflection ### 1. What went well during this unit? -[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] +Brainstorming new ideas went very smoothly. We were able to come up with a few ideas and narrow them down to one that we were both interested in. We found common ground in the ideas and felt that we could both apply our skills to the project. + +Additionally, we planned out the timeline and decided the meeting times to keep +each other accountable and divide up tasks based on our preferences/skills. ### 2. What were some challenges your group faced in this unit? -[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] +We had some issues analyzing the scope of this project, as there are some features +that we may not be able to complete within the given time frame. However, we +decided to write them down to focus on the core, required features first and then +move on to the additional features if we have time. + +Outside of the project, we had some issues with our personal schedules and +school work, but we were able to find time to work on the project individually +and meet up to discuss our progress. ### 3. What additional support will you need in upcoming units as you continue to work on your final project? -[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ your answer here] +We may need support for drawing out the backend architecture to build the database +and connect it to the frontend. We may also need support for deploying the app and +allowing users to create an account with the school email. We will need to look +into how to do this and may need some help with it. diff --git a/planning/user_stories.md b/planning/user_stories.md index 1e55ecbcd..803adea95 100644 --- a/planning/user_stories.md +++ b/planning/user_stories.md @@ -4,10 +4,20 @@ Reference the Writing User Stories final project guide in the course portal for ## Outline User Roles -[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ Include at least at least 1, but no more than 3, user roles.] +- Tenants (Seeking Sublets or Roommates) +- Users Seeking Housing + ## Draft User Stories -[πŸ‘‰πŸΎπŸ‘‰πŸΎπŸ‘‰πŸΎ Include at least at least 10 user stories in this format:] +1. As a college student looking for housing, I want to create a user profile using my school email to access listings and connect with potential roommates. +2. As a tenant with a sublease opportunity, I want to post my sublease details, including the location, cost, and lease duration, so that I can find a suitable replacement and make the process seamless. +3. As a student looking for a sublet, I want to filter sublease listings based on preferences such as gender, age, and location to find the most suitable housing options. +4. As a tenant with a lease, I want to post my lease details and indicate my preferences for additional roommates to find compatible roommates to join my lease. +5. As a student looking for a lease, I want to filter lease listings based on the preferences of current tenants, such as gender, age, and location, to find housing that matches my criteria. +6. As a student seeking housing, I want to create a user post with my bio, preferences, hobbies, and budget range so that potential roommates and landlords can learn more about me and reach out. +7. As a tenant or user looking for housing, I want to view detailed listings that include information on the names of tenants, location, cost, lease duration, contact info, and any additional notes. +8. As a tenant or user looking for housing, I want to see a list of students' profiles who are searching for housing and filter them based on criteria like major, age, and budget to find potential roommates. +9. As a user, I want to save or like listings and profiles to create a shortlist for easy reference and further consideration. +10. As a tenant or user seeking housing, I want to connect with other users, either to express interest in their listings or to discuss potential housing arrangements. -1. As a [user role], I want to [what], so that [why].