House Rental Notifier

I was tired of daily searching for houses on multiple real estate websites.
Instead, this does it for me and sends me a WhatsApp message when something new arrives.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Running
4. Roadmap
5. Contributing
6. Contact

About The Project

A crawler that looks for new entries on different real estate websites registered manually. And, once it founds it, it send a whatsapp message with a brief and a link.

The idea is to make it more generic and gather data for different subjects in the future.

(back to top)

Built With

The design made directly in the CLI, using native cursors from Node.js. Here are a few examples of frameworks/libraries used in this project.

• Node.js
• MongoDB
• Chalk
• Puppeteer
• Typescript
• Twilio

(back to top)

Getting Started

Prerequisites

For this project you will need npm. Docker and yarn are optional.

• nvm

• yarn

  npm install yarn@latest -g

• docker

Installation

1. Clone the repo

   git clone https://github.com/gabrielsiedler/house-rental-notifier.git

2. Install NPM packages

   yarn

3. Edit the environment file in .env

   TWILIO_ACCOUNT_SID=
   TWILIO_AUTH_TOKEN=
   TWILIO_TARGET_NUMBER=
   MONGODB_URI=

(back to top)

Running

  docker-compose up mongo
  yarn start

(back to top)

Roadmap

• Add sources selectors manually
• Add Whatsapp messaging with Twilio
• Add CLI design
• Make CLI responsive
• Make project generic
  • Move sources to a json structure
  • Change wording

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Adds some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Gabriel Siedler - linkedin - [email protected]

Project Link: https://github.com/gabrielsiedler/house-rental-notifier

(back to top)