Giter VIP home page Giter VIP logo

greenhack-prague's Introduction

OptiEnergy

OptiEnergy is a web-based platform aimed to provide a simple and user friendly way for users to invest in green energy.

Features

Implemented Features

  • Solar Panel Suitability Check: Users can input their address to determine if their house is suitable for solar panels, the required investment, and the return on investment (ROI) period.

Mocked Features

  • Neighbor Energy Marketplace: Shows neighbors who already have solar energy and are willing to sell it, providing an alternative for users who don't want or can't invest in solar panels.
  • Provider Listings: Displays a list of solar panel providers and their prices for users interested in investing in solar panels.

Architecture

The architecture of OptiEnergy leverages modern web technologies to provide a scalable and efficient platform. The frontend is built with React and Vite, while the backend uses AWS Lambda functions managed by the Serverless Framework. This setup ensures a serverless, cost-effective, and highly scalable infrastructure.

Architecture flow

Tech Stack

  • Frontend: React, Vite, JavaScript
  • Backend: AWS Lambda, Serverless Framework, JavaScript
  • Cloud Provider: AWS

Installation and Running Instructions

Prerequisites

  • Node.js (>= 14.x)
  • AWS CLI configured with appropriate permissions
  • Serverless Framework (npm install -g serverless)

### Frontend

  1. Clone the repository:
git clone [email protected]:Vinny-Bass/greenhack-prague.git
cd greenhack-prague
  1. Navigate to the frontend directory:
cd frontend/opt-energy
  1. Install dependencies:
npm install
  1. Run the development server:
npm run dev

Backend

  1. Navigate to the backend directory:
cd backend
  1. Select the service you want to change/test:
cd lambdas/<service_name>
npm install
  1. To run offline:
sls offline

Now you can change the env in the frontend to http://localhost:<port_of_service>

## Contributing Contributions are welcome! Please fork the repository and use a feature branch. Pull requests are reviewed and merged based on their innovation, usability, sustainability, and scalability.

License

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

greenhack-prague's People

Contributors

vinny-bass avatar

Watchers

 avatar

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.