https://github.com/jcloh98/rental-property-finder

A web scraper that helps users find rental properties by automatically gathering and organizing listings from various websites to discover available homes and apartments.
https://github.com/jcloh98/rental-property-finder

data headless-browser node scraper scraping web

Last synced: 4 days ago
JSON representation

A web scraper that helps users find rental properties by automatically gathering and organizing listings from various websites to discover available homes and apartments.

• Host: GitHub
• URL: https://github.com/jcloh98/rental-property-finder
• Owner: JCLOH98
• License: mit
• Created: 2024-12-09T13:05:17.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-23T13:36:10.000Z (17 days ago)
• Last Synced: 2024-12-23T14:37:17.631Z (17 days ago)
• Topics: data, headless-browser, node, scraper, scraping, web
• Language: CSS
• Homepage:
• Size: 91.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# rental-property-finder

A web scraper that helps users find rental properties by automatically gathering and organizing listings from various websites to discover available homes and apartments.\

\

**CURRENTLY SUPPORT GETTING DATA IN MALAYSIA ONLY.**

## Tech stack

- backend 

    - Express

    - Puppeteer (headless browser)

- frontend

    - TailwindCSS

## Dev Commands

- backend

    - `npm run dev` to run development server

- frontend

    - need to `npx tailwindcss -i ./styles.css -o ./output.css --watch` to build the **styles.css** *(will become output.css)*

    - need to `npx webpack --mode development --watch` to build the **index.js** *(will become bundle.css as it is setup in webpack.config.js)*

## Build Commands

- backend

    - no build as will run as server.

- frontend

    - need to `npx tailwindcss -i ./styles.css -o ./output.css` to build the **styles.css** *(will become output.css)*

    - need to `npx webpack --mode production` to build the **index.js** *(will become bundle.css as it is setup in webpack.config.js)*

## Run Commands

- backend

    - `npm start`

- frontend 

    - just open the `index.html` after build

## Note

- refer to [`https://pptr.dev/supported-browsers`](https://pptr.dev/supported-browsers) to check the browser compability with pupeteer

- might need to setup OSRM server for map routing (can refer to [`https://ipv6.rs/tutorial/Windows_10/Open_Source_Routing_Machine_(OSRM)/`](https://ipv6.rs/tutorial/Windows_10/Open_Source_Routing_Machine_(OSRM)/))

> **If you find this project helpful and enjoyable, consider supporting it with a tip on [Kofi](https://ko-fi.com/jcloh98).**