Skip to content

GoEco is a project that solves the issue of energy sources. This website is going to help people in finding which renewable energy source is best for their location.

Notifications You must be signed in to change notification settings

tannuiscoding/GoEco

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

GoEco

GoEco is a web application that tackles the issue of sustainable energy selection. It helps users identify the most suitable renewable energy source for their location based on current weather conditions.

GoEco

🌟 Features

  • 🔍 Real-time weather data integration using the WeatherAPI to assess temperature, wind speed, cloud cover, and rainfall.
  • ⚡ Predicts the best renewable energy source (solar, wind, hydro, geothermal) for a given location.
  • 💰 Calculates government incentives, carbon reduction, installation cost, money saved, and return on investment (ROI).
  • 🛍 Intuitive UI to input city, sunshine hours, proximity to water sources, and geothermal activity.

🛠 Tech Stack

  • HTML, CSS, JavaScript
  • Python, Flask
  • WeatherAPI

🧪 Installation Steps

  1. Clone the repository

    First, open your terminal or command prompt. Then, run the following command to download the GoEco project code to your local machine:

    git clone https://github.com/your-username/GoEco.git

    Navigate into the project directory:

    cd GoEco
  2. Create a virtual environment (optional but recommended)

    This helps keep your project dependencies isolated.

    python -m venv venv

    Activate the virtual environment:

    • Windows:
      venv\Scripts\activate
    • Mac/Linux:
      source venv/bin/activate
  3. Install required packages

    All dependencies are listed in the requirements.txt file located in the Get Started section. Install them using:

    pip install -r get-started/requirements.txt
  4. Set up your WeatherAPI key

    • Go to WeatherAPI.com and sign up for a free account.
    • After verifying your email, you'll receive an API key.

    Now, set this key as an environment variable:

    • Windows (Command Prompt):
      set WEATHER_API_KEY=your_api_key_here
    • Windows (PowerShell):
      $env:WEATHER_API_KEY="your_api_key_here"
    • Mac/Linux:
      export WEATHER_API_KEY=your_api_key_here

    Alternatively, you can hardcode it in your app.py file:

    API_KEY = os.getenv("WEATHER_API_KEY", "your_api_key_here")
  5. Run the Flask application

    Once everything is set up, start the Flask server:

    python app.py

    If everything is configured correctly, you'll see output like:

    * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
    
  6. Open the app in your browser

    Go to http://127.0.0.1:5000 to use the GoEco web app locally.

📌 Usage Guide

  1. Enter Location and Preferences

    • On the Get Started or Service page, enter the city name and sunshine hours.
    • Optionally, check if the location is near a water source or in a geothermal region.
  2. Submit the Form

    • Click on "Find Renewable Energy Sources" to trigger predictions.
  3. View Results

    • Get detailed insights on:
      • Recommended energy source
      • Government incentives
      • Carbon emission reduction
      • Estimated installation cost
      • Total money saved
      • ROI (Return on Investment)

📄 License

This project is licensed under the MIT License. View License

Feel free to contribute, raise issues, or fork the repository to support sustainability!

About

GoEco is a project that solves the issue of energy sources. This website is going to help people in finding which renewable energy source is best for their location.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7