Website  |   Demo

**Default Login:** - Username: `admin` - Password: `admin` ------------------------------------------------------------------------ ## 📸 Screenshots | Fredy Main Overview | Job Configuration | Found Listings | |--------------------------------------------------|-----------------------------------------------------------------------|-----------------------------------------------------------------------------| |  |  |  | ------------------------------------------------------------------------ ## 🧩 Core Concepts Fredy is built around three simple concepts: ### Provider 🌐 A **provider** is a real-estate platform (e.g. ImmoScout24, Immowelt, Immonet, eBay Kleinanzeigen, WG-Gesucht).\ When you create a job, you paste the search URL from the platform into Fredy.\ ⚠️ Always make sure the search results are sorted by **date**, so Fredy picks up the newest listings first. ### Adapter 📡 An **adapter** is the channel through which Fredy notifies you (Slack, Telegram, Email, ntfy, discord ...).\ Each adapter has its own configuration (e.g. API keys, webhook URLs).\ You can use multiple adapters at once --- Fredy will send new listings through all of them. ### Job 📅 A **job** combines providers and adapters.\ Example: "Search apartments on ImmoScout24 + Immowelt and send results to Slack + Telegram."\ Jobs run automatically at the interval you configure (see `/conf/config.json`). ------------------------------------------------------------------------ ## Immoscout Immoscout has implemented advanced bot detection. In order to work around this, we are using a reversed engineered version of their mobile api. See [Immoscout Reverse Engineering Documentation](https://github.com/orangecoding/fredy/blob/master/reverse-engineered-immoscout.md) ## Analytics Fredy is completely free (and will always remain free). However, it would be a huge help if you’d allow me to collect some analytical data. Before you freak out, let me explain... If you agree, Fredy will send a ping once every 6 hours to my internal tracking project (Will be open sourced soon). The data includes: names of active adapters/providers, OS, architecture, Node version, and language. The information is entirely anonymous and helps me understand which adapters/providers are most frequently used.

**Thanks**🤘 ## 🛠️ Development ### Development Mode ``` bash yarn run start:backend:dev yarn run start:frontend:dev ``` You should now be able to access _Fredy_ from your browser. Check your Terminal to see what port the frontend is running on. ### Run Tests ``` bash yarn run test ``` ------------------------------------------------------------------------ ## 📐 Architecture ``` mermaid flowchart TD subgraph Jobs["Jobs"] A1["Job 1"] A2["Job 2"] A3["Job 3"] end subgraph Providers["Providers"] C1["Provider 1"] C2["Provider 2"] C3["Provider 3"] end subgraph NotificationAdapters["Notification Adapters"] F1["Adapter 1"] F2["Adapter 2"] end A1 --> B["FredyRuntime"] A2 --> B A3 --> B B --> C1 & C2 & C3 C1 --> D["Similarity Check"] C2 --> D C3 --> D D --> E{"Duplicate?"} E -- No --> F1 F1 --> F2 ``` ------------------------------------------------------------------------ ## 👐 Contributing Thanks to everyone who has contributed! See the [Contributing Guide](https://github.com/orangecoding/fredy/blob/master/CONTRIBUTING.md). ------------------------------------------------------------------------ ## ⭐ Star History [](https://www.star-history.com/#orangecoding/fredy&Date)