/FHIT

Financial Health Score Calculator

Primary LanguagePHP

Financial Health Indicator Tool Documentation

Project Reporting on WakaTime

wakatime

Live Demo: https://fhit.imerfan.com

Demo

Table of Contents

  1. Introduction
  2. Features
  3. Tech Stack
  4. Installation
  5. Usage
  6. Architecture
  7. Security
  8. Data Visualization
  9. Database Integration
  10. Testing
  11. User-Centric Focus
  12. Documentation
  13. Deployment
  14. Contributing
  15. License

Introduction

The Financial Health Indicator Tool, following an MVC (Model-View-Controller) and Service-Driven Architecture, is designed to assist small businesses in understanding and improving their financial health. This tool provides a comprehensive Financial Health Score by analyzing monthly income, expenses, debts, and assets. This documentation serves as a guide on setting up, using, and understanding the different aspects of the tool.

Features

  1. Financial Health Score Calculator: Allows businesses to input monthly income, expenses, debts, and assets, and provides a clear Financial Health Score.

  2. Engaging and Intuitive Interface: Developed with Livewire and Laravel for a smooth and engaging user experience.

  3. Robust Back-End System: Utilizes Laravel's MVC architecture and a service-driven approach for flexibility and a robust back-end.

  4. Responsive Data Visualization: Integrates Apex Charts for visual representation of the Financial Health Score and key metrics.

  5. Database Integration: Efficiently handles data using Laravel's Eloquent ORM with MySQL/PostgreSQL for secure storage.

  6. Security Measures: Encrypts all sensitive financial information before saving it into the database.

  7. Testing for Reliability: Conducts tests using Pest to ensure the tool's functionality and reliability.

Tech Stack

  • Back-End: Laravel (MVC, Service-Driven)
  • Front-End: Livewire
  • Database: MySQL/PostgreSQL
  • Data Visualization: Apex Charts
  • Testing: Pest
  • Deployment: RunCloud, VPS, WebHook, deployer script.

Installation

  1. Clone the repository:

    git clone https://github.com/imerfanahmed/FHIT

  2. Navigate to the project directory:

    cd fhit

  3. Install dependencies:

    composer install

  4. Set up the database and configure the .env file.

    php artisan migrate

Usage

  1. Start the Laravel development server:

    php artisan serve

  2. Open your browser and go to http://localhost:8000 to access the Financial Health Indicator Tool.

Architecture

The tool follows a Laravel-based architecture with MVC and a service-driven approach for flexibility and a robust back-end.

Security

The tool ensures security by encrypting all sensitive financial information before saving it into the database. Database

Data Visualization

Visual representation of the Financial Health Score and key metrics is achieved through Apex Charts.

Chart

Database Integration

Efficient data handling is ensured through the integration of Laravel's Eloquent ORM with [MySQL/PostgreSQL].

Testing

Both automated and manual tests are conducted using PHPUnit to ensure the tool's reliability. !Test

User-Centric Focus

The tool is designed with small business owners in mind, aiming for ease of use and understanding. Feedback and suggestions are welcomed for continuous improvement.

Deployment

The tool can be deployed on platforms like Laravel Forge, Heroku, etc., for public access. I have deployed here using RunCloud Server Manager, VPS From UpCloud, WebHook, and deployer script. Project is Dockerized as well. Deployment

License

This project is licensed under the MIT License.