a-n-u-b-i-s/surgesaver

Save money. Save the planet.

SurgeSaver

Save money. Save the planet.

Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Demand for electricity varies greatly throughout the day, and companies have responded by charging more for power during certain hours to disincentivize use. “Peaker plants” are inefficient power plants only used in these hours of peak consumption, and are the source of some of the country’s worst pollution. Most people aren’t aware of the hours when they should reduce consumption, and end up paying up to 10x as much per kWh for things like running their AC mid-day. With our application, users will be notified when surge pricing is likely to occur, and will be able to reduce energy use to both save money and help the environment by avoiding "peaker plants".

Built With

• Twilio API
• VueJs
• Saas
• AWS Lambda
• AWS S3

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Please install the following tools to contribute.

• npm
• sass

brew install node
brew install sass/sass/sass

Usage

SurgeSaver tracks live and predictive Locational Marginal Pricing (LMP) across over 20 energy/power utilities in the Midwest and Mid Atlantic. We send text-alerts to users when price gouging is likely to occur within the next 24 hours, giving them the necessary information to make informed decisions regarding their power usage. In addition, the application compiles and displays informative visualizations of demand trends.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Anubis Watal - LinkedIn - email
Tessa Danehy - LinkedIn - email
Lukas Houpt - LinkedIn - email
Neil Kothari - LinkedIn - email

Project Link: https://github.com/a-n-u-b-i-s/SurgeSaver

surgesaver's Issues

Exposed API token.

Currently, you can view your Twilio token within your index.js.

You should probably use something like the .env npm package. It allows you to put all your tokens in a process.env file, then you add that file to a git exclude.

you should also reset the token so that nobody can get it by looking at the git history.

Broken page

When attempting to load the web page, a 404 is sent. Regardless of this, you're still able to view the (majority) of the page.

The only problem is, it seems that the only part missing from the page is the actual feature that people came to it for.
Looking at console logs, it seems that the error is thrown on line 36 of graph.js.

Looking at the network, the original page 404'd, but then still sent the body + js scripts after.
Based on what the headers say, I believe it has something to do with a key you are using for aws, as when I try to load http://surgesaver.com.s3-website-us-east-1.amazonaws.com/index.html, it loads just fine.

Headers:

How to self host.

There was no documentation on how to run this project. Due to this, I had to kind of make it up on my own.

After a bit of fiddling around, I managed to figure out that I need to run the web\index.js file, but it throws errors when I try to run it.

The first error (ReferenceError: Vue is not defined at var fin = new Vue({) was fixed by adding var Vue = require('vue'); just above it.

The next error (ReferenceError: updateGraphZ is not defined at updateGraphZ(V.analyticsZipCode);) is something I have no clue how to fix. It seems that this is a function within the graph.js file.
After importing those functions with this hacky bit of code, it threw yet another error:

var fs = require("fs");

eval(fs.readFileSync('graph.js')+'');

After that, it was giving me ReferenceError: window is not defined at an unknown point. From what I can tell, you're trying to use a variable that doesn't exist. I saw references to window, but there were no assignments to it.

I would greatly appreciate if you could add documentation on how to host this.