Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hexagon/spotweb
Dockerized Deno application that gets and caches electricity prices (spot price) from ENTSO-e.
https://github.com/hexagon/spotweb
api deno electricity-prices fresh homeassistant rest rest-api spotprice website
Last synced: 26 days ago
JSON representation
Dockerized Deno application that gets and caches electricity prices (spot price) from ENTSO-e.
- Host: GitHub
- URL: https://github.com/hexagon/spotweb
- Owner: Hexagon
- License: mit
- Created: 2022-11-24T23:37:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T20:41:20.000Z (4 months ago)
- Last Synced: 2024-10-10T15:06:27.507Z (about 1 month ago)
- Topics: api, deno, electricity-prices, fresh, homeassistant, rest, rest-api, spotprice, website
- Language: TypeScript
- Homepage: https://spot.56k.guru
- Size: 4.64 MB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spotweb
Source code of [https://spot.56k.guru](https://spot.56k.guru) - dockerized open source Deno application that gets and caches electricity prices (spot
price) from ENTSO-e.Currently available in Swedish, Finnish, Danish, Norwegian, Spanish, French, Polish and German.
Any feedback on translations are greatly appreciated. Contribute by opening an issue, or by creating a pull request. Each language has it's own file
in `config/translations`.[![Deno CI](https://github.com/Hexagon/spotweb/actions/workflows/deno.yaml/badge.svg)](https://github.com/Hexagon/spotweb/actions/workflows/deno.yaml)
### Development
Start the project, pass your Entso-e api key in environment variable `API_TOKEN` (in windows powershell):
```
$env:API_TOKEN="your-entsoe-api-token"; deno task dev
```#### Contributing
Pull requests are very welcome! Please run `deno task precommit` before submitting a pr. This will make sure format, linting, types are up to
standards, and tests pass.#### Dependency updates
To update fresh framework using recommended method:
```
deno task update-fresh
```To check for general dependency updates:
```
deno task update-deps
```Apply the updates manually
Also check `SwHead.tsx` for dependencies included by script tags.
Note that the types declarations in deno.json have to be updated if updating dependencies in `import_map.json` or script-tags in `SwHead.tsx`.
### Running in production
Spotweb is set up to run using [Pup](https://github.com/hexagon/pup) in production. Follow tre quick guide there to run `pup run` or install as a
system service `pup install --name spotweb`The database will be stored in `/db/`
```
-v /path/on/host/spotweb/db:/spotweb/db
```