Skip to content

Personal project meeting personal needs: see all the properties matching your criteria on one page, by extracting them from your alert emails

Notifications You must be signed in to change notification settings

Bouss/boussimmo

Repository files navigation

Boussimmo

Scrutinizer Code Quality Code Coverage Build Status Code Intelligence Status

Searching your property through the email alerts and using your Gmail address? Tired of wasting time opening and reading a lot of emails all the day? Fed up of seeing the same properties on different websites? Try BoussImmo!

Screenshot from 2021-04-28 11-40-50 https://www.boussimmo.com

Stack

  • PHP 8.0
  • Symfony 5.3
  • jQuery 3.5
  • Gmail API
  • Google OAuth 2.0

Dev

Requirements

  • PHP 8.0.0 (or higher)
  • MySQL 8.0 (or higher) or PostgreSQL 12 (or higher)
  • Composer 2
  • Yarn
  • A Google API key (create yours on Google Cloud Platform)
  • A Google OAuth 2.0 client (create yours on Google Cloud Platform)
  • symfony binary (download here)

Configuration

  • Create your own .env.local file by coping/pasting the .env file
  • In the .env.local file:
    • Replace the value of the DATABASE_URL env var with your own database URL
    • Replace the value of the GOOGLE_API_KEY env var with your own Google API key
    • Replace the value of the GOOGLE_CLIENT_XXX env vars with the credentials of your own Google OAuth2.0 client

Installation

$ composer install
$ bin/console doctrine:migration:migrate
$ yarn install
$ yarn dev

Usage

Start the web server:

$ symfony serve
  • Subscribe to alert emails on property websites (Bien'Ici, LeBonCoin, Logic-Immo, Ouestfrance-immo, PAP, ParuVendu, SeLoger, SuperImmo) with your Gmail address
  • On the homepage, sign-in with the same Gmail address
  • Visit BoussImmo as long as it is necessary

Tests

$ ./bin/phpunit

About

Personal project meeting personal needs: see all the properties matching your criteria on one page, by extracting them from your alert emails

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published