Skip to content

Latest commit

 

History

History
153 lines (111 loc) · 4.73 KB

USERMANUAL.md

File metadata and controls

153 lines (111 loc) · 4.73 KB

logo

NestQuest is an online marketplace that connects homeowners who want to rent out their properties with travelers seeking unique accommodations. This platform offers a seamless experience for listing, exploring, and reviewing properties, complete with interactive map integration.

Features

  1. Home Page

    • Overview of the platform.
    • Quick access to explore available properties.

  2. User Authentication

    • Sign Up: Create an account with a username and password.
    • Login: Access your account using credentials.
    • Logout: Securely log out when you're done.

  3. Listings Management

    • Browse Listings: View all available properties, including images, descriptions, and reviews.
    • Add New Listing: Post a property for rent, including title, description, price, and location.
    • Edit Listing: Modify details of your property.
    • Delete Listing: Remove a property you no longer wish to list.

  4. Search & Filtering(Implement latter)

    • Search properties based on keywords (e.g., location or property type).
    • Filter results by price, amenities, or reviews.

  5. Interactive Map

    • View property locations on a map (powered by Mapbox).
    • Hover or click on map markers to view property details.

  6. Reviews and Ratings

    • Leave reviews for properties you’ve stayed in.
    • View ratings and feedback from other users.

  7. Responsive Design

    • Fully optimized for desktop, tablet, and mobile devices.

Getting Started

1. Accessing the Website

Visit the website at: NestQuest

2. Signing Up

  • Navigate to the Sign Up page.
  • Fill in the required details:
    • Username
    • Password
  • Click Submit to create your account.
  • After Sign Up the user Logged In automatically.

3. Logging In

  • Go to the Login page.
  • Enter your username and password.
  • Click Submit to access your account.

4. Logging Out

  • Click the Logout button in the navigation bar to securely end your session.

Using Core Features

1. Browsing Listings

  • Go to the Explore page.
  • Scroll through the list of properties or search for a specific property using the search bar(Search bar implement latter).

2. Adding a New Listing

  • Log in to your account.
  • Navigate to Add Listing.
  • Fill in the form fields:
    • Title
    • Description
    • Price
    • Location(with precise location)
    • Upload images of the property.
  • Click Submit to post your listing.

3. Editing or Deleting a Listing

  • Log in to your account.
  • View your own listings.
  • Click Edit to modify details or Delete to remove the listing.

4. Reviewing a Property

  • Open the property details page.
  • Scroll to the Reviews section(One user allow to post only one review for a perticular property & User allow to post their own review to their own property..
  • Add your feedback and submit your review.

5. Viewing the Map

  • Open the map from the property details page.
  • Hover over or click on location markers to see property details.

Best Practices

For Listing Owners

  • Ensure your property description and images are accurate(followes all checks when submit).
  • Respond to inquiries promptly to attract more renters.

For Renters(Implement latter)

  • Check reviews and ratings before booking a property.
  • Contact the owner if you have questions or concerns.

General

  • Log out after using the site to keep your account secure.
  • Avoid sharing sensitive information in public reviews.

Troubleshooting

1. Login Issues

  • Ensure your username and password are correct.
  • Reset your password if you've forgotten it(Working).

2. Problems Adding Listings

  • Ensure all required fields are filled.
  • Check that the uploaded images meet size and format requirements.

3. Map Not Loading

  • Verify your internet connection.
  • Refresh the page or try a different browser.

4. Review Submission Not Working

  • Make sure you are logged in.
  • Ensure your review text meets the length requirements.

5. Admin Feature

  • Admin Feature(Working)

Technologies Used

  • Frontend: Bootstrap, EJS, HTML, CSS, JavaScript
  • Backend: Node.js, Express.js
  • Database: MongoDB Atlas
  • Map Integration: Mapbox SDK
  • Cloud Storage: Cloudinary

Contact Support

If you encounter any issues or have feedback, reach out to the NestQuest support team at: [email protected]

License

NestQuest is an open-source project. Feel free to fork, use, or contribute to this project. Check the license details in the repository.