Skip to content

daithihearn/electricity-prices-go

Repository files navigation

Electricity Prices API

codecov

An API for electricity prices in Spain. Data is scraped from REData Api and exposed via a restful API.

This API supports a dashboard application, an Alexa Skill and Flash briefing.

In addition to the API there is a sync job that can be run separately to sync data from REData.

This repo is a replacement for the original implementation written in Kotlin.

Stack

  • Go
  • MongoDB

API

To run locally you will need to have a MongoDB instance running. Update the MONGO_URL environment variable to point to your instance. You will also require make to be installed.

Then to run locally simply run:

make run

To build the executable binaries locally run:

make build

The binaries will be installed in the build folder and can be run directly.

If you want to build the docker image run:

make image

Sync Job

To run the sync locally run:

make sync

The make build command described in the API section will build both binaries.

The make image command described in the API section will build a single docker image for both the API and sync job.

To run the docker image for the sync job run like so:

docker run -d --rm elec-prices-sync ./sync

Running without the ./sync will run the API.

CORs

You must configure CORs by setting an environment variable CORS_ALLOWED_ORIGINS to a comma separated list of origins. For example:

CORS_ALLOWED_ORIGINS=http://localhost:3000,https://preciosdelaelectricidad.es

Please ensure there are no spaces in the list.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages