Skip to content
/ docs Public

Starting point. High-level overview of the Brokalys platform

Notifications You must be signed in to change notification settings

brokalys/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Docs

A high-level overview of the Brokalys tech.

diagram

Goals

Brokalys is a real estate aggregation and analysis platform built by Matiss Janis Aboltins as a side-project.

The main goals are:

  1. Make local real estate analysis available to everyone;
  2. Automate everything: data collection, analysis, normalization and display process;
  3. Make it cheap.

All of this is achieved through the clever use of modern technology and lots of tweaking and optimizations. This includes - using serverless technologies, pre-calculating statistical data, using static web hosting for frontends.

Frontend

Each project is a separate micro-frontend with only one functionality. This helps keep project complexity and size down. Furthermore, it creates the opportunity to try new things and experiment in an isolated environment.

The CI/CD pipeline setup for each project is very important to guarantee reproducible and automated deployments. Some projects might not see a commit in months or even years, so CI/CD is very important.

The map is the most commonly used public frontend. It's an easy way to view real estate data for a specific region or criteria. This could be - the median price change within a region, the buy-to-let ratio for apartments, the number of classifieds published within a certain month, or many more things.

View map-app LIVE version

Pinger app is a very simple Vue application for signing up for the Brokalys PINGER. It sends out email notifications when a real-estate classified has been crawled that matches a user predefined criteria (e.g. classified type, price range, region, room count, etc.).

View pinger-app LIVE version

Simple React app for unsubscribing to PINGERs.

The main entry point to the Brokalys platform - the main website. Very minimalistic Jekyll landing page.

View homepage LIVE version

Backend

Broakyls backend is built to be 1) scalable; 2) fast; 3) cheap. It consists of many serverless functions that work independently - just like microservices. They communicate with each other via API calls or SNS notifications.

Crawlers

The meat of the entire Brokalys operation. Around 50 unique real estate crawlers for gathering a complete dataset of the real-estate market. Since this project is the single most important piece of the operation, the source code is private.

A minimalistic serverless GraphQL API acting as a gateway between the DigitalOcean MySQL database and every other service. Data can be retrieved, inserted, and updated only via sls-api.

A scheduled serverless function for checking if a classified matches some customer pre-defined parameters. If they match - send the customer a notification email.

This service also takes care of rate-limiting the emails sent out (100/customer/month). This is to save costs on the email sending service. The limit can be increased if a customer communicates with the Brokalys team directly.

Functions for extracting statistical data from the database. Stores this information in a static CSV file on Github for public and easy access.

The data is available in the data repository.

Database

The database is the most expensive and most crucial piece of infrastructure in the Brokalys platform.

As of this writing, the MySQL database is hosted on a cheap DigitalOcean instance. It can be only accessed via sls-api. It has two databases - properties and pingers. sls-api has write&read permissions to the properties database, but not update or delete due to security concerns. And sls-api also has write, update and read access to the pingers database.

A public, static data database is also available on GitHub. It contains various statistical data exported from the Brokalys DB.

About

Starting point. High-level overview of the Brokalys platform

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published