Skip to content

Yannaner/SustainAI

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SustainAI: Your Personal Guide to Sustainable Living

Last Commit Languages Stars Forks


Table of Contents


Overview

SustainAI is an AI-powered web application that serves as your personal sustainability assistant. It offers tailored recommendations, actionable insights, and an engaging chatbot interface—all aimed at helping you reduce your environmental impact.


Inspiration

Climate change and environmental challenges can feel overwhelming. SustainAI was born out of the desire to empower individuals by bridging the gap between sustainability awareness and actionable change. Our goal is to transform everyday decisions into meaningful contributions for a healthier planet.


What It Does

  • Personalized Sustainability Advice: Offers customized recommendations based on user data.
  • Interactive Chatbot: Engages users with AI-driven, natural language conversations using the OpenAI GPT-3.5-Turbo API.
  • Data Integration: Combines information from health apps, purchase histories, and transportation methods.
  • Action Tracking: Allows users to monitor sustainable actions, build streaks, and track progress.
  • Educational Resources: Provides a rich library of content on sustainability topics.

How We Built It

  • Frontend: Developed with React and styled with Tailwind CSS for a responsive and intuitive interface.
  • Backend: Powered by Node.js with Express.js, handling API requests and integrating external services.
  • Database: Utilizes MongoDB Atlas for scalable, secure data storage.
  • AI Integration: Leverages the OpenAI GPT-3.5-Turbo API to deliver natural, engaging conversations.
  • MATLAB Integration: Converts complex WAD files (Walk Activity Data) into structured formats (CSV/JSON) for enhanced data processing.

Challenges

  • AI Chatbot Integration: Balancing engaging conversation with actionable sustainability advice.
  • Data Integration: Managing diverse data sources while ensuring robust privacy and security.
  • WAD File Processing: Developing MATLAB scripts to accurately convert binary data into usable formats.
  • Time Constraints: Delivering a fully functional project within a hackathon timeframe.

Accomplishments

  • Integrated AI to deliver real-time, personalized sustainability advice.
  • Successfully developed MATLAB scripts for reliable WAD file conversion.
  • Implemented engaging user features such as streak tracking and action logging.
  • Maintained ethical data handling and robust security throughout the project.

What We Learned

  • Advanced our skills in AI and natural language processing.
  • Gained comprehensive experience in full-stack web development and data integration.
  • Learned specialized techniques in MATLAB for processing complex data formats.
  • Enhanced our teamwork, project management, and problem-solving abilities.

What's Next

  • Mobile Application Development: Creating native apps for iOS and Android.
  • Enhanced Personalization: Utilizing advanced machine learning for even more tailored advice.
  • Community Features: Introducing challenges, leaderboards, and social sharing.
  • Voice Assistant Integration: Providing hands-free interaction for improved accessibility.

Project Structure

SustainAI/
├── client/                  # Frontend application (React)
├── server/                  # Backend API (Node.js & Express)
├── matlab-env/              # MATLAB scripts for WAD file conversion
├── my-eco-chat/             # Chatbot implementation and AI integration
├── .gitignore
├── package.json
├── README.md                # This file
└── other configuration files

Installation & Usage

Prerequisites

Installation

  1. Clone the Repository:
    git clone https://github.com/Yannaner/HackPrinceton24.git
    cd HackPrinceton24
  2. Install Dependencies:
    cd client
    npm install
    cd ../server
    npm install
  3. Configure Environment Variables:
    Create a .env file in the server directory with the necessary configuration (e.g., MongoDB URI, OpenAI API keys).

Running the Application

  • Start the Backend:
    cd server
    npm start
  • Start the Frontend:
    cd client
    npm start
  • Access the Application:
    Open your browser and navigate to http://localhost:3000

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a feature or bugfix branch.
  3. Commit your changes with clear messages.
  4. Open a pull request detailing your improvements.

License

This project is licensed under the MIT License.


Acknowledgements

  • aymane-omari/HackPrinceton – Inspiration and foundational code.
  • The HackPrinceton team and all contributors for their support.
  • OpenAI for providing innovative AI technology.

About

SustainAI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 74.1%
  • JavaScript 21.0%
  • MATLAB 2.3%
  • Python 2.0%
  • Shell 0.6%