Skip to content

rjpmestre/mortgage-plan-analyzer

Repository files navigation

Mortgage Plan Analyzer

This Laravel project, developed as part of SUSE Hack Week 23, is a collaborative effort aimed at simplifying the analysis of housing loan proposals, with a focus on common configurations in Portugal.

Overview

The Mortgage Plan Analyzer focuses on analyzing proposals that typically have two phases: an initial fixed-rate phase followed by a variable phase composed of a contracted spread and variable Euribor. This project aims to streamline and clarify the financial decision-making process for common housing loans in Portuguese territory.

Links

Contacts

How to Contribute

If you are interested in contributing to the Mortgage Plan Analyzer project, feel free to fork the repository and submit pull requests. Your contributions are welcome!

Version

Current version: v1.0.1a

Installation

Need:

  • php
  • git
  • docker
  • composer

Execute

# clone the project
git clone https://github.com/rjpmestre/mortgage-plan-analyzer.git mpa
cd mpa

# basic setup
sudo composer update
cp .env.example .env
# generate your app key
php artisan key:generate
# optional adjust .env file: APP_URL and/or RAPID_API_KEY_EURIBOR [https://rapidapi.com/lrdavocado-O3qmwiGJQwR/api/euribor/]

# build and start docker container
sudo docker-compose build mpa-app
chmod -R 777 storage
sudo ./vendor/bin/sail up -d