search

dhogborg / off-peak

Analyze energy usage
GNU Affero General Public License v3.0
46 stars 10 forks source link

Documentation for client.env variables #15

Closed khromov closed 2 years ago

khromov commented 2 years ago

I'm trying to run this project locally via docker-compose.yml but it complains about a missing client.env file. However there is not documentation for this file.

Would it be possible to create a client.env.sample file with the variables that need to be provided, or is is simply these ones? (And if so, is Firebase a hard requirement to run this project?)

dhogborg commented 2 years ago

Correct, here is the env spec: https://github.com/dhogborg/off-peak/blob/master/client.example.env

You can youse your own firebase credentials but the functionality is optional. Set dummy values if you are not developing or testing snapshot functionality.

The Tibber OAuth part requires approval from Tibber to use their SSO. This is not feasible for development work. During development, you can use a personal token from https://developer.tibber.com/settings/access-token , store it under localStorage as access_token and set the expires key to a value far in the future.