Git Product home page Git Product logo

carbonitor's Introduction

Carbonitor: Carbon Footprint Estimator for Plastic Waste

About the Project

Carbonitor is an application designed to estimate the carbon footprint of plastic waste materials. Utilizing an image classification model, this application can identify different types of plastic bottles and calculate their carbon footprint based on predefined parameters. This project aims to raise awareness about the environmental impact of plastic waste and encourage more sustainable practices.

Features

  • Image Classification: Identifies plastic bottle types using a sophisticated image classification model.
  • Carbon Footprint Calculation: Estimates the carbon footprint of identified plastic waste.
  • User-Friendly Interface: Built with React, offering a responsive and interactive user experience.
  • Local Data Storage: Utilizes IndexedDB for efficient data storage and retrieval.

Technologies Used

  • React: For building the user interface.
  • IndexedDB: For local data storage and management.
  • Nyckel: For image classification.

Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js
  • npm (Node Package Manager)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/carbonitor.git
  2. Navigate to the project directory:

    cd carbonitor
  3. Install NPM packages:

    npm install

Available Scripts

In the project directory, you can run:

  • Development Server

    npm run dev

    Runs the app in the development mode. Open http://localhost:3000 to view it in your browser.

  • Build for Production

    npm run build

    Builds the app for production to the dist folder.

  • Linting

    npm run lint

    Lints and fixes files.

  • Preview Production Build

    npm run preview

    Locally preview production build.

carbonitor's People

Contributors

huenique avatar

Watchers

 avatar

carbonitor's Issues

Development of User Interface (UI)

User Story

"As a user, I want an intuitive and easy-to-navigate interface where I can view and understand my daily plastic waste carbon footprint."

Acceptance Criteria

  • The interface should be user-friendly and intuitive.
  • Users should be able to easily navigate through the application and access various features without difficulty.

Tasks

  • Design and implement a UI that displays the carbon footprint sensor's data.
  • Include features for users to view carbon footprint information and updates.

Scope

  • This task is solely focused on the UI design and implementation for the Carbonitor application.

Dependencies

  • Requires close collaboration with the team implementing the carbon footprint sensor to ensure accurate data display.

Implementation of Carbon Footprint Sensor

User Story

"As a user, I want the application to accurately measure the carbon footprint of my daily plastic waste so I can understand my environmental impact."

Acceptance Criteria

  • The sensor should accurately identify different types of plastic waste.
  • The sensor should provide an estimated carbon footprint of the identified plastic waste.

Tasks

  • Research and integrate an existing algorithm or API that can identify and calculate the carbon footprint of various types of plastic.
  • Test the sensor's accuracy and reliability with different plastic waste samples.

Scope

  • The task is limited to implementing and testing the sensor feature in the application.

Dependencies

  • Requires knowledge on various plastic types and their respective carbon footprints.
  • Dependence on a reliable external API or algorithm, if not developing from scratch.

Data Accuracy and Application Testing

User Story

"As a developer, I need to ensure that the application provides accurate data and is reliable for users to use on a daily basis."

Acceptance Criteria

  • The application should pass all designed test cases.
  • Data provided by the application should be accurate and reliable.

Tasks

  • Develop test cases for application features, including the carbon footprint sensor, information display, and updates.
  • Conduct testing and document results, making necessary adjustments to improve accuracy and reliability.

Scope

  • This task involves developing and running tests for the application and making necessary adjustments based on test results.

Dependencies

  • Requires completed implementation of the carbon footprint sensor and UI to conduct comprehensive tests.

Implementation of Recommendations Feature

User Story

"As a user, I want personalized recommendations on reducing my carbon footprint based on the plastic waste I generate."

Acceptance Criteria

  • The application should provide relevant and actionable recommendations to users.
  • Recommendations should be personalized based on users' plastic waste data.

Tasks

  • Implement a feature that analyzes users' plastic waste data and provides recommendations for reducing their carbon footprint.
  • Test the recommendations feature for accuracy and relevance.

Scope

  • This task involves implementing and testing the recommendations feature in the Carbonitor application.

Dependencies

  • Requires accurate data from the carbon footprint sensor to provide relevant recommendations.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.