https://github.com/gateremark/hometopia
A comprehensive and user-friendly web platform designed to revolutionize the way people buy, sell, and rent properties, the goal being to connect prospective homeowners, tenants, and real estate professionals with their perfect housing solutions.
https://github.com/gateremark/hometopia
firebase-auth firestore-database leafletjs react-icons react-router react-toastify reactjs swiperjs tailwindcss vercel-deployment vitejs
Last synced: 12 months ago
JSON representation
A comprehensive and user-friendly web platform designed to revolutionize the way people buy, sell, and rent properties, the goal being to connect prospective homeowners, tenants, and real estate professionals with their perfect housing solutions.
- Host: GitHub
- URL: https://github.com/gateremark/hometopia
- Owner: gateremark
- Created: 2023-05-29T23:21:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T16:47:47.000Z (over 2 years ago)
- Last Synced: 2025-07-02T02:02:56.247Z (12 months ago)
- Topics: firebase-auth, firestore-database, leafletjs, react-icons, react-router, react-toastify, reactjs, swiperjs, tailwindcss, vercel-deployment, vitejs
- Language: JavaScript
- Homepage: https://hometopia.vercel.app/
- Size: 16.4 MB
- Stars: 22
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://react.dev/) : A JavaScript library for building user interfaces.
- [Tailwind CSS](https://tailwindcss.com/) : A utility-first CSS framework for rapidly designing responsive web pages.
- [Firebase](https://firebase.google.com/) : A comprehensive development platform that provides authentication services and a NoSQL database (Firestore) for user management and data storage.
- [React Leaflet](https://react-leaflet.js.org/) : An open-source React library for interactive maps.
- [Swiper JS](https://swiperjs.com/) : A modern and mobile-friendly slider library for creating interactive carousels and sliders.
- [React Toastify](https://fkhadra.github.io/react-toastify/introduction/) : A customizable toast notification library for React applications.
- [React Icons](https://react-icons.github.io/react-icons/): A collection of popular icons as React components.
- [Vite](https://vitejs.dev/) : A fast and efficient build tool for modern web development.
- [Vercel](https://vercel.com/) : 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:
```bash
https://github.com/gateremark/hometopia.git
```
2. Install the dependencies:
```bash
cd hometopia
```
```bash
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:
```env
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:
```javascript
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://hometopia.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.