Note: This was built for HackSingapore2023 where we won 1st place with a prize of $800 amongst 70 teams. All keys are expired
The journey of creating our platform was sparked by a shared concern for the environmental impact of the ever-growing digital landscape. Witnessing the rapid consumption of resources by software and its contribution to the carbon footprint, we were inspired to make a change. Our goal became clear: to develop a solution that would transform code into a driving force for sustainability.
As we delved into the world of software optimization and environmental impact analysis, we found ourselves on a steep learning curve. We immersed ourselves in diverse fields, from software engineering and algorithms to environmental science and energy efficiency.
Our project swiftly took shape in just one day by harnessing the power of an LLM API. We leveraged this technology to analyze code structures, identify optimization opportunities, and propose sustainable alternatives. Despite the short timeframe, we managed to create a user-friendly interface that seamlessly assists developers in integrating eco-conscious practices into their code projects. The process was streamlined, with quick iterations focused on refining and enhancing the capabilities of our platform.
However, this rapid development journey wasn't without its challenges. Adapting the LLM API for code analysis required careful fine-tuning, as it wasn't originally designed for this specific task. We encountered hurdles in training the model to accurately identify code inefficiencies and propose relevant sustainable solutions. Additionally, creating a comprehensive database of sustainable web guidelines and ensuring the generated recommendations aligned with real-world practices posed its own set of difficulties. Despite these obstacles, our determination to make a positive impact on code sustainability kept us motivated throughout the process.
- Carbon Footprint Tracking: Measure and track the environmental impact of your code.
- GPT Chatbot: Get real-time insights and suggestions for optimizing your code for sustainability.
- CSS3
- Express.js
- HTML5
- JavaScript
- Node.js
- React
- Vite
- Visual Studio Code
To set up and run the Sustainable Code Revolution platform locally, follow these steps:
- Clone this repository.
- Install the necessary dependencies using
npm install. - Start the development server with
npm start. - Access the platform through your web browser at
http://localhost:3000.
We welcome contributions from the community to help improve and expand the Sustainable Code Revolution project. If you have ideas, feedback, or want to contribute code, please follow these steps:
- Fork this repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your fork.
- Create a pull request to this repository with a clear description of your changes.
- [Parth Kumar] - Project Lead
- [Elisabeth Fung] - Developer
- [Andrea Cheah] - Developer
If you have any questions, suggestions, or feedback, please don't hesitate to reach out to me @Eqedos
Let's code for a greener, more sustainable future together!