Skip to content

Measure & Improve: Personal Carbon Footprint Estimation via Activity Data Parsing, Emission Factor Modelling, and Interactive Sustainability Reporting

License

Notifications You must be signed in to change notification settings

Dancull/Sustainability-Footprint-Tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sustainability-Footprint-Tool: Measure & Improve: Personal Carbon Footprint Estimation via Activity Data Parsing, Emission Factor Modelling, and Interactive Sustainability Reporting

A full-stack web application that tracks, calculates, and visualizes sustainability footprints using live data, with client-side charts and PDF export capabilities.

Features

  • Real-Time Data Visualization: Dynamic charts powered by Chart.js for instant sustainability insights.
  • PDF Export: Generate detailed footprint reports client-side using jsPDF.
  • Progressive Web App (PWA): Offline support and installability via service workers.
  • Server API: Node.js backend with environment configuration for secure data management.
  • Modular Design: Clear separation of frontend (public) and backend (private/server) logic.

Prerequisites

  • Node.js 16+ (with npm)
  • Modern web browser for PWA features

Installation

# Clone the repo
git clone https://github.com/Dancull/Sustainability-Footprint-Tool.git

# Install backend dependencies
cd Sustainability-Footprint-Tool/private
npm install

# Start backend server
npm start

# Open frontend
# Serve the 'public' folder (e.g. using live-server or VS Code Live Server)

Usage

Open the app in your browser via the local server or static host. Interact with the dashboard to view sustainability footprint charts, export reports as PDFs, and use offline features if PWA is installed.

Hackathon & Project Origin

This project was initially inspired by the EU Climate Hack and other sustainability-focused competitions, completed as a 36-hour MVP sprint. The goal was to rapidly prototype a personal carbon footprint tracker that offers actionable sustainability insights.

MVP Features

  • Log travel, diet, and shopping habits through an intuitive web form.
  • Calculate estimated carbon footprint using fixed emission multipliers.
  • Display “Weekly Goals” with progress bars to motivate users.
  • Export footprint summaries as PDFs using static HTML to PDF conversion.
  • Provide a colour-coded “Eco Rating” for quick impact assessment.

License

Including a LICENSE file clarifies how others may use, modify, and distribute your code. By choosing an open-source license such as MIT, you grant permission for use under defined terms while protecting your intellectual property and limiting liability.

This project is licensed under the MIT License. See LICENSE for full details.

Project Structure

Sustainability-Footprint-Tool/
├── public/                     # Frontend assets and client scripts
│   ├── app.js                  # Main client app logic
│   ├── chartjs-helper.js       # Chart.js helper functions
│   ├── index.html              # Main HTML page
│   ├── jspdf-helper.js         # jsPDF helper for PDF export
│   ├── manifest.json           # PWA manifest configuration
│   ├── style.css               # Stylesheet
│   └── sw.js                   # Service Worker for PWA
├── private/                    # Backend and server files
│   ├── node_modules/           # Node.js dependencies
│   ├── server/                 # Server source code (Express or similar)
│   ├── .env                    # Environment variables (not committed)
│   ├── index.js                # Server entry point
│   ├── package-lock.json       # Dependency lock file
│   └── package.json            # Project metadata and scripts
├── README.md                   

Roadmap

Implimentation has been taken care of however need to ensure the full backend works.

  • User authentication (sign in with Google)
  • Cloud sync, saving/loading data
  • AI-driven recommendations and summaries
  • Leaderboard, group/family features
  • Location-based recommendations (weather, transport)
  • Streaks, points, badges that depend on backend data

Author

About

Measure & Improve: Personal Carbon Footprint Estimation via Activity Data Parsing, Emission Factor Modelling, and Interactive Sustainability Reporting

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published