Milestone1branch

README.md

@@ -1,20 +1,20 @@
-# [your app name here]
+# StayVue
 
 CodePath WEB103 Final Project
 
-Designed and developed by: [your names here]
+Designed and developed by: Saoirse Siobhan Ebert and Hafeefa Sulttan
 
 🔗 Link to deployed app:
 
 ## About
 
 ### Description and Purpose
 
-[text goes here]
+StayVue is your ultimate travel companion, seamlessly merging the world of accommodations with an exclusive rewards program, connecting you to local businesses for a personalized and unforgettable travel experience. Whether you're a wanderlust-filled traveler or an enthusiastic host, StayVue is combination of exceptional stays and rewards that make travel memories even more rewarding. Travelers can experience unique accommodation experiences, write reviews and share their own experiences and earn points in return. The more you travel, the more you earn. Collect points on each stay, each review, and through a referral program. A user can redeem their earned points for discounts on future bookings, exclusive deals, and gift cards for local businesses. Additionally, users will get personalized recommendation and stay connected to local businesses, which means that the app's mission extends to not only providing awesome travel arrangements but supporting the businesses in which the accomodation is near. Users can communicate with hosts for a seamless booking process and personalized travel guidance, the hosts can show their trust value with verified identities and properties.
 
 ### Inspiration
 
-[text goes here]
+StayVue's mission goes beyond just booking accommodations; it's about enriching travel experience by connecting you to the heart and soul of your destination—its local businesses. StayVue is a gateway to immersive travel, rewards, and connections with local communities. Airbnb and other accomodations apps are a huge inspiration for this capstone, but extending the mission in this way is a huge factor into creating a culture of giving back to those communities and the folks who live there.
 
 ## Tech Stack
 
@@ -24,24 +24,68 @@ Backend:
 
 ## Features
 
-### [Name of Feature 1]
+### Accommodation Search
 
-[short description goes here]
+Users can search for accommodations based on location, dates, and preferences.
 
 [gif goes here]
 
-### [Name of Feature 2]
+### Detailed Accommodation Listings
 
-[short description goes here]
+sers can view detailed property listings with descriptions, photos, amenities, and reviews.
 
 [gif goes here]
 
-### [Name of Feature 3]
+### Booking Process
 
-[short description goes here]
+Users can easily book accommodations with a streamlined booking process.
 
 [gif goes here]
 
+### Review Submission
+
+Users can submit and edit, and delete reviews and star ratings for accommodations they've stayed in.
+
+### Review Points System
+
+Users earn points for submitting reviews and ratings.
+
+### Points and Rewards Dashboard
+
+Users have access to a dashboard displaying their earned points and redeemed rewards.
+
+### Real-Time Reviews
+
+Users can view real-time reviews and ratings from other travelers while browsing accommodation listings.
+
+### Redeem Points for Discounts and Perks
+
+Users can use their earned points to receive discounts on future bookings and experiences within the local community that the booking is at
+
+### Property Management
+
+Hosts can create and manage property listings with descriptions, photos, and pricing.
+
+### In-App Messaging
+
+Hosts and guests can communicate through in-app messaging.
+
+### Host Verification
+
+Hosts can verify their identity and properties to build trust with users.
+
+### Calendar Availability
+
+Hosts can manage and display property availability calendars.
+
+### Cancellation Policy
+
+Hosts can set cancellation policies for their properties.
+
+## Installation Instructions
+
+[instructions go 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]
 
 ## Installation Instructions

milestones/milestone1.md

@@ -6,26 +6,27 @@ 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]
+
+[👉🏾👉🏾👉🏾 What went well during this unit was how quickly and swiftly we acted as a team as soon as we found out we were teammates. We developed a clear and innovative concept for our app. We then went on to make user stories, where we successfully created comprehensive user stories that detailed the user's perspective with our app, which made us realize on a deeper level about what a user would want from our application.]
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+[👉🏾👉🏾👉🏾 As a team of just two people, we had a bit of confusion because I had a hackathon commitment. But we talked it out and adjusted our project schedule. We also both had college to deal with, so we made a shared calendar and split our tasks better. Despite the challenges, we learned to manage our time and communicate effectively, and we still got our project done.]
 
 ### 3. What additional support will you need in upcoming units as you continue to work on your final project?
 
-[👉🏾👉🏾👉🏾 your answer here]
+[👉🏾👉🏾👉🏾 As we continue with our final project, we could use extra help in a few areas. It'd be great to get feedback from instructors and mentors to ensure we're on the right track. Also, technical support, access to necessary tools, and help with any technical issues would be beneficial.]

milestones/milestone2.md

@@ -6,22 +6,22 @@ This document should be completed and submitted during **Unit 6** of this course
 
 This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
 
-- [ ] In `planning/wireframes.md`: add wireframes for at least three pages in your web app
-- [ ] In `planning/entity_relationship_diagram.md`: add the entity relationship diagram you developed for your database
-- [ ] Prepare your three-minute pitch presentation, to be presented during Unit 7 (the next unit)
-  - [ ] You do **not** need to submit any materials in advance of your pitch
-- [ ] In this document, complete the **Reflection** section below
+- [x] In `planning/wireframes.md`: add wireframes for at least three pages in your web app
+- [x] In `planning/entity_relationship_diagram.md`: add the entity relationship diagram you developed for your database
+- [x] Prepare your three-minute pitch presentation, to be presented during Unit 7 (the next unit)
+  - [x] You do **not** need to submit any materials in advance of your pitch
+- [x] In this document, complete the **Reflection** section below
 
 ## Reflection
 
 ### 1. What went well during this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+[👉🏾👉🏾👉🏾 Working on time with each other went really well. We were able to complete the basic wireframes on Monday and worked together until completion. We met again on Friday in order to discuss how to complete how the 3 pages will be visualized, and we were able to finish that quickly and swiftly. We also divided the rest of the tasks equally between us throughout the week to ensure none of us were overwelmed with too much work. ]
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+[👉🏾👉🏾👉🏾The visualization of the pages became a bit of a challenge for us. We tried to encorporate what other similar sites were like and how we would like to make the site appear. We came up with a color scheme along with this but were not able to implement it into our figma right away, as the color did seem a bit off. We hope to fix this issue as soon as possible while designing the site and have clean, simple UI in the actual website]
 
 ### 3. What additional support will you need in upcoming units as you continue to work on your final project?
 
-[👉🏾👉🏾👉🏾 your answer here]
+[👉🏾👉🏾👉🏾 In the future, it would just be great if our mentor can visit us more often for helping us out with the visualization and the coloring of the webpage. Furthermore, it would be great to discuss the ideas we have come up with her so we can reach a conclusion about what we should finalize in our website]

planning/user_stories.md

@@ -1,13 +1,69 @@
 # User Stories
 
-Reference the Writing User Stories final project guide in the course portal for more information about how to complete each of the sections below.
-
 ## Outline User Roles
 
-[👉🏾👉🏾👉🏾 Include at least at least 1, but no more than 3, user roles.]
+- Host Role:
+
+Description:
+
+`A host is a user who lists their property or accommodation on the platform for travelers to book. Hosts play a pivotal role in providing lodging and experiences to travelers, sharing their spaces and local insights.`
+
+- Traveler Role:
+- 
+Description:
+
+`A traveler is a user who seeks accommodations or experiences on the platform for their trips. Travelers use the platform to discover and book a variety of lodging options, from vacation rentals to hotels, based on their preferences and travel plans.`
 
 ## Draft User Stories
 
-[👉🏾👉🏾👉🏾 Include at least at least 10 user stories in this format:]
+1. `As a traveler, I want to find accommodations in my desired location, so I can plan my trip.`
+
+- Users can search for accommodations based on location, dates, and preferences.
+
+2. `As a traveler, I want to see detailed information and photos of accommodations, so I can make an informed decision.`
+
+- Users can view detailed property listings with descriptions, photos, amenities, and reviews.
+
+3. `As a traveler, I want to book accommodations with ease, so I can secure my stay.`
+
+- Users can easily book accommodations with a streamlined booking process.
+
+4. `As a traveler, I want to leave reviews and ratings for accommodations after my stay, so I can share my experiences.`
+
+- Users can submit reviews and star ratings for accommodations they've stayed in.
+
+5. `As a traveler, I want to earn points for leaving reviews, so I can be rewarded for my feedback.`
+
+- Users earn points for submitting reviews and ratings.
+
+6. `As a traveler, I want to see my accumulated points and rewards in one place for easy access.`
+
+- Users have access to a dashboard displaying their earned points and redeemed rewards.
+
+7. `As a traveler, I want to receive personalized recommendations for accommodations based on my previous bookings and preferences.`
+
+- The app provides users with tailored accommodation recommendations based on their history and preferences.
+
+8. `As a traveler, I want to see real-time reviews and ratings from other travelers while exploring accommodations.`
+
+- Users can view real-time reviews and ratings from other travelers while browsing accommodation listings.
+
+9. `As a traveler, I want to redeem my earned points for discounts on future bookings, so I can save on my travels.`
+
+- Users can use their earned points to receive discounts on future bookings.
+
+10. `As a host, I want to create and manage property listings, so I can attract guests.`
+
+- Hosts can create and manage property listings with descriptions, photos, and pricing.
+
+11. `As a host, I want to communicate with guests through in-app messaging, so I can provide assistance and answer questions.`
+
+- Hosts and guests can communicate through in-app messaging.
+
+12. `As a host, I want to manage property availability through an integrated calendar, so I can keep my listings up to date.`
+
+- Hosts can manage and display property availability calendars.
+
+13. `As a host, I want to define clear cancellation policies for my properties, so guests understand the terms.`
 
-1. As a [user role], I want to [what], so that [why].
+- Hosts can set cancellation policies for their properties.