-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
39 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# 🏡 Hoomes: Your Gateway to Italian Real Estate 🏡 | ||
|
||
Welcome to **Hoomes**, the ultimate tool for scraping and searching homes for sale in Italy! Whether you're dreaming of a cozy Tuscan villa, a chic Milanese apartment, or a seaside retreat in Sicily, Hoomes has you covered. Currently, it supports scraping data from [Idealista](https://www.idealista.it/) and [Caaasa.it](https://www.caasa.it/), with plans to extend to other leading real estate platforms. | ||
|
||
## 🌟 What Hoomes Does | ||
|
||
Hoomes pulls listings from popular Italian real estate platforms and allows you to perform powerful full-text searches across the descriptions of each scraped property. Imagine being able to search for keywords like "panoramic view," "garden," or "historical center" across thousands of listings in seconds! | ||
|
||
## 🚀 Getting Started | ||
|
||
### Clone the Repository | ||
|
||
```bash | ||
git clone https://github.com/yourusername/hoomes.git | ||
cd hoomes | ||
``` | ||
|
||
### Bootstrap Your Development Environment | ||
|
||
To kickstart your development environment, use the following command: | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
This command will start all necessary services concurrently, ensuring that your development environment is fully operational with a single command. The `concurrently` package is used under the hood to run multiple npm scripts simultaneously, streamlining your workflow and minimizing setup time. | ||
|
||
## 🛠️ Future Enhancements | ||
|
||
Hoomes is designed with scalability in mind. We aim to integrate additional real estate platforms, making it easier than ever to find your dream home in Italy. Stay tuned for updates and new features! | ||
|
||
## 🤝 Contributing | ||
|
||
We welcome contributions! If you'd like to add a new feature, fix a bug, or improve the documentation, feel free to open a pull request. Let's build something amazing together. | ||
|
||
## 📜 License | ||
|
||
Hoomes is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. |