Skip to content
Tang ZhaoSheng edited this page Nov 8, 2024 · 25 revisions

Welcome to the Project Documentation!

This project aims to develop an innovative system that automates the extraction of ESG (Environmental, Social, and Governance) information from unstructured reports, providing in-depth analysis and insights into ESG performance across industries.


Project Overview

Project Goal

This project aims to develop a streamlined system that automates the extraction of ESG (Environmental, Social, and Governance) information from unstructured reports, providing comprehensive insights into ESG performance across selected industries. By leveraging GMFT technology for table extraction, this project enhances data quality and accuracy, enabling users to efficiently assess corporate sustainability practices through a dedicated web application.

Implementation Details

  • Data Extraction: Uses GMFT technology to automate table extraction from PDF reports, combined with custom programming to further process ESG data.
  • Frontend: Built using React for dynamic visualizations and user interactions.
  • Backend: A dual backend approach using Python and Node.js to handle complex data processing and API interactions.
  • Data Storage and Authentication: Incorporates Firebase for user authentication, MySQL for structured data storage, and AWS S3 for file storage.

Project Structure

graph TD
    Client[Frontend Client]
    PY[Python Backend :5106]
    NODE[Node.js Backend :5105]
    DB[(MySQL Database)]
    FB[Firebase Auth]
    S3[AWS S3 Storage]

    Client --> PY
    Client --> NODE
    PY --> DB
    NODE --> DB
    NODE --> FB
    PY --> S3
Loading

Features

ESG Dashboard

The dashboard provides a centralized view of the extracted ESG data, offering the following key sections:

  • ESG Ranking: A ranked list of companies based on their ESG scores for the year 2023, enabling quick comparison between companies within the same industry.

  • ESG Analysis: A detailed panel focusing on individual companies, such as Apple, showing fluctuations in ESG scores from 2019 to 2023 with trend predictions.

  • ESG Metrics: A visual breakdown of the ESG scores into Environmental, Social, and Governance categories, represented as a pie chart to illustrate distribution among the three pillars.

ESG Score Trend by Company

Displays ESG score trends for individual companies over recent years. Users can track the performance of a selected company, highlighting changes over time.

Environmental Rating (2023)

A bar chart representing the environmental rating of various companies in 2023. This chart enables a quick comparison of environmental performance across companies, helping identify industry leaders in sustainability.

Environmental Score Trend by Company

This line chart shows the environmental score trend for individual companies, providing insights into significant changes in environmental performance over time.


Pages

  • Home
    The main landing page with project goals and features.

  • API Documentation
    Details on API endpoints used in this project.

  • Data Sources
    Overview of data sources used for ESG scoring.

  • ESG Scoring System
    Insights into the scoring methodology for ESG metrics.

  • GMFT (Table Extraction)
    Explanation of the GMFT-based table extraction process.

  • Preprocessing
    Steps for preprocessing data for analysis.

  • Tech Stack Overview
    A look into the core technologies used, including Firebase Authentication, Firebase Storage, and MySQL.

  • Usage Guide
    Instructions on using the main features of the application.

Feel free to explore each page for more details about the project.

Clone this wiki locally