Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 3.51 KB

README.md

File metadata and controls

85 lines (64 loc) · 3.51 KB
Raw

HomeTopia

Welcome to HomeTopia, a powerful web platform for buying, selling, and renting properties. Find your dream home or perfect investment property with ease.

Technologies Used

  • ReactJS : A JavaScript library for building user interfaces.
  • Tailwind CSS : A utility-first CSS framework for rapidly designing responsive web pages.
  • Firebase : A comprehensive development platform that provides authentication services and a NoSQL database (Firestore) for user management and data storage.
  • React Leaflet : An open-source React library for interactive maps.
  • Swiper JS : A modern and mobile-friendly slider library for creating interactive carousels and sliders.
  • React Toastify : A customizable toast notification library for React applications.
  • React Icons: A collection of popular icons as React components.
  • Vite : A fast and efficient build tool for modern web development.
  • Vercel : A cloud platform for static site deployment.

Features

  • Comprehensive property listings with detailed descriptions and images.
  • Interactive maps powered by Leaflet to explore property location(s).
  • Secure authentication and user management using Firebase.
  • Offers: Submit offers for properties on offer.
  • Direct contacting the property owner on the platform.
  • Sell or rent property by creating a listing on the platform.
  • Seamless deployment and hosting with Vercel.

Getting Started

To get started with HomeTopia locally, follow these steps:

  1. Clone the repository:

    https://github.com/DNX EMPIRE/hometopia.git

  2. Install the dependencies:

    cd hometopia
    pnpm install

  3. Configure Firebase authentication: Create a Firebase project and obtain the necessary credentials. Update the Firebase configuration in src/firebase.jsx with your own credentials.

  4. Register for a Geocoding API via Google Cloud

    • Create a .env.local file in the root directory of the project.

    • Register for a geocoding API key via the Google Cloud platform. You can follow the official documentation to obtain the API key.

    • Open the .env.local file and add the following line:

      VITE_REACT_APP_API_KEY=YOUR_API_KEY

      Replace YOUR_API_KEY with the actual API key you obtained from Google Cloud. By setting up the .env.local file with the appropriate API key, the application will be able to access the geocoding API and provide accurate property locations.

  5. Start the development server:

    pnpm start

  6. Open your browser and visit specified local host port to view the app eg. http://localhost:5173

Deployment

HomeTopia is deployed using Vercel. Any changes pushed to the main branch will trigger an automatic deployment. You can visit the live version of HomeTopia at https://real-estate-sepia-theta.vercel.app/

Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request.

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes and commit them.
  4. Push to the branch.
  5. Submit a pull request.