HomeStay

The Homestay Project is a web application that enables users to sign up and log in. Hosts can manage homestay listings, while guests can search and book properties by country and category. Guests can also leave reviews, and hosts can visually specify property locations on a map interface.

Features

• Allow users to sign up and log in securely.
• Hosts can create, update, and delete homestay listings.
• Guests can search for properties based on country, category.
• Allow guests to leave reviews and ratings for homestays they have booked.
• Hosts can specify the geographic location of their properties visually on a map interface.

Installation

Clone the repository:

 git clone https://github.com/aryanag7/homestay-project.git

Navigate to the project directory:

 cd homestay-project

Install dependencies:

npm install

Setting Up Environment Variables. Follow these steps to create and configure the .env file:

• Create a new file named .env in the root directory of the project.
• Copy and paste the following template into your .env file.

# Cloudinary Configuration
CLOUD_NAME=your_cloud_name
CLOUD_API_KEY=your_cloud_api_key
CLOUD_API_SECRET=your_cloud_api_secret

# Mapbox Configuration
MAP_TOKEN=your_mapbox_token

# MongoDB Atlas Configuration
ATLASDB_URL=your_mongodb_atlas_url

# Session Secret
SECRET=your_session_secret

• Replace your_cloud_name, your_cloud_api_key, your_cloud_api_secret, your_mapbox_token, your_mongodb_atlas_url, and your_session_secret with your actual credentials obtained from the respective services.
• Save the .env file in the root directory of your project.

NOTE: Ensure that you do not share your .env file or its contents publicly. Add .env to your .gitignore file to prevent it from being committed to version control.

Screenshots

Homepage

Listing Details

User Signup & Login

Filtering & Searching

Tech Stack

• Frontend:

  • HTML/CSS
  • Bootstrap
  • JavaScript

• Backend:

  • Node.js
  • Express.js
  • MongoDB (Atlas for database hosting)

• Cloud Services:

  • Cloudinary (for image storage and management)

• Mapping:

  • Mapbox (for visualizing property locations)

Usage

• Register as a new user or log in with existing credentials.
• Explore available homestays by searching or browsing through listings.
• View detailed information about each homestay.
• Leave reviews and ratings for homestays you have booked.

Contributing

Contributions to this project are welcome! To contribute:

• Fork the repository.
• Create a new branch (git checkout -b feature/new-feature).
• Commit your changes (git commit -am 'Add new feature').
• Push to the branch (git push origin feature/new-feature).
• Submit a pull request.