Skip to content

OSU-Sustainability-Office/energy-dashboard

Repository files navigation

OSU Energy Dashboard

Frontend StatusAPI Status Test Build Status

This Energy Dashboard has been developed by the Oregon State University Sustainability Office to enable members of the OSU community to access, view, and analyze energy consumption trends. The production build of this application can be found at https://dashboard.sustainability.oregonstate.edu. A test build is hosted on an AWS S3 bucket here.

Contributors "Hall of Fame"

Testing Locally

We recommend setting up nvm to set your node installation to version 18 (nvm use 18).

Running npm run serve will run the front-end locally.

To run the serverless backend API locally you'll want to run sam local start-api (docker will need to be running first).

Formatting

Run both in order

  • npm run prettier
  • npm run lint --fix

Documentation

For more detailed information about how the dashboard front-end works internally, there's a README.md with the vue components described under the documents/frontend directory.