UMH2024

ShariahMetric is a project aimed at providing tools and solutions to analyze and evaluate financial products and services from a Shariah-compliant perspective. The project is designed to assist financial institutions, investors, and individuals adhering to Islamic principles in making informed decisions about their investments and financial activities.

React App Installation and Setup Guide

This guide provides step-by-step instructions to download, install, and run the React app on your local machine.

Prerequisites

• Node.js and npm should be installed on your computer. You can download and install Node.js from here.

Steps to Download and Run the React App

1. Download the Source Code:

   • Download the source code of the React app provided to you.

2. Extract the Zip File:

   • If the code was provided as a zip file, extract it to a location on your computer.

3. Open Terminal or Command Prompt:

   • Open a terminal or command prompt window on your computer.

4. Navigate to Project Directory:

   • Use the cd command to navigate to the directory where you extracted the source code. For example:

     cd path/to/your/project
     

5. Install Dependencies:

   • Run the following command to install the dependencies required by the app:

     npm install
     

6. Run the React App (Development Mode):

   • Start the development server by running the following command:

     npm run dev
     

   • This will compile the React app and open it in your default web browser. You can now view and interact with the app.
   • This will redirect you to the localhost:5173, ctrl+click to view the website

Troubleshooting

• If you encounter any errors during the installation process or while running the app, try running npm install again with the --legacy-peer-deps flag:

Key features and components of ShariahMetric may include:

Analysis Tools: ShariahMetric offers various analytical tools and algorithms tailored to assess the compliance of financial products with Islamic law (Shariah). These tools help users evaluate the Shariah compliance of investment options, banking products, insurance policies, and other financial instruments.

Data Integration: The platform integrates with relevant data sources, market indices, and databases to provide up-to-date information on financial products and market trends. This data is crucial for conducting Shariah compliance assessments and performance analysis.

Customizable Criteria: ShariahMetric allows users to define and customize Shariah compliance criteria based on their specific requirements and interpretations of Islamic law. Users can set parameters and filters to screen financial products according to their individual preferences and investment guidelines.

Reporting and Monitoring: ShariahMetric generates comprehensive reports and dashboards that summarize the Shariah compliance status of financial products and portfolios. Users can monitor compliance trends, track performance metrics, and receive alerts about any deviations from Shariah principles.