OptiEnergy is a web-based platform aimed to provide a simple and user friendly way for users to invest in green energy.
- 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.
- 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.
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.
- Frontend: React, Vite, JavaScript
- Backend: AWS Lambda, Serverless Framework, JavaScript
- Cloud Provider: AWS
- Node.js (>= 14.x)
- AWS CLI configured with appropriate permissions
- Serverless Framework (
npm install -g serverless
)
### Frontend
- Clone the repository:
git clone [email protected]:Vinny-Bass/greenhack-prague.git
cd greenhack-prague
- Navigate to the frontend directory:
cd frontend/opt-energy
- Install dependencies:
npm install
- Run the development server:
npm run dev
- Navigate to the backend directory:
cd backend
- Select the service you want to change/test:
cd lambdas/<service_name>
npm install
- 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.
This project is licensed under the MIT License. See the LICENSE file for more details.