Skip to content

Flutter App- this repo contains the route page for the CarbonCourier app.

Notifications You must be signed in to change notification settings

PhoenixAlpha23/CarbonCourier

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Carbon Emission Calculator

This is a Flutter application that calculates carbon emissions based on cargo weight and travel distance using the Google Maps API. The app integrates with Supabase for user management and authentication.

Table of Contents

  1. Overview
  2. Features
  3. Technologies Used
  4. Setup Instructions
  5. Folder Structure
  6. Usage
  7. Future Improvements

Overview

This project is designed to provide an estimate of carbon emissions for trips based on input factors:

  • Distance between two locations (calculated via Google Maps API)
  • Cargo weight entered by the user

The application is ideal for logistics, delivery services, and eco-conscious users looking to monitor environmental impact.

Supabase is used to handle user authentication and management.


Features

  • User Authentication: Login and registration powered by Supabase.
  • Distance Calculation: Calculates travel distance using Google Maps API.
  • Carbon Emission Estimation: Computes carbon emissions based on cargo weight and travel distance.
  • Interactive Map: Visualize start and end points on Google Maps.

Technologies Used

  • Flutter (UI development for cross-platform compatibility)
  • Google Maps API (distance and map visualization)
  • Supabase (user management and authentication)

Setup Instructions

Follow these steps to set up the project locally:

Prerequisites

Steps

  1. Clone this repository:

    git clone <https://github.com/PhoenixAlpha23/CarbonCourier/tree/main>
    cd <lib>
  2. Install dependencies:

    flutter pub get
  3. Add API keys:

    • Create a .env file in the root folder.
    • Add your Google Maps API key and Supabase credentials.
    GOOGLE_MAPS_API_KEY=your_google_maps_key_here
    SUPABASE_URL=your_supabase_url_here
    SUPABASE_ANON_KEY=your_supabase_anon_key_here
    
  4. Run the app:

    flutter run

Folder Structure

project-folder/
├── assets/                 # App images and icons
├── lib/                    # Main source code
│   ├── main.dart           # Entry point of the app
│   ├── pages/              # Screens for the app
│   ├── services/           # API and backend integrations
│   ├── widgets/            # Reusable components
├── pubspec.yaml            # Project dependencies
└── README.md               # Project documentation

Usage

  1. Run the App

    • Launch the app on a simulator/emulator or physical device.
  2. Log In / Sign Up

    • Register or log in using Supabase authentication.
  3. Calculate Carbon Emissions:

    • Enter cargo weight.
    • Select the starting point and destination on the map.
    • View the calculated distance and carbon emissions.

Future Improvements

  • Data Storage: Save previous trips and carbon calculations in a database.
  • Advanced Estimations: Incorporate fuel types and vehicle efficiency for more accurate emissions.
  • UI Enhancements: Improve the interface for better user experience.
  • Analytics Dashboard: Display visual reports on carbon footprints over time.

Contribution

Contributions are welcome! If you find any bugs or have suggestions, feel free to open an issue or submit a pull request.


License

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

About

Flutter App- this repo contains the route page for the CarbonCourier app.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published