https://github.com/spwareing/energyapifunction
Azure Function for shaping API calls to the Octopus Energy API
https://github.com/spwareing/energyapifunction
azure-functions csharp
Last synced: about 1 year ago
JSON representation
Azure Function for shaping API calls to the Octopus Energy API
- Host: GitHub
- URL: https://github.com/spwareing/energyapifunction
- Owner: SPWareing
- License: mit
- Created: 2024-10-27T17:09:28.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-31T07:57:58.000Z (over 1 year ago)
- Last Synced: 2025-03-25T09:11:41.030Z (about 1 year ago)
- Topics: azure-functions, csharp
- Language: C#
- Homepage:
- Size: 796 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Energy Api Function
This repository contains an Azure function for making calls to the [Octopus Energy API]("https://developer.octopus.energy/") , built using .NET.
It is designed to fronted by a React App which turns the returned JSON object into an Energy Consumption Dashboard
## Getting Started
### Prerequisites
- [.NET SDK](https://dotnet.microsoft.com/download)
- [Visual Studio Code](https://code.visualstudio.com/) or any other code editor
### Installation
1. Clone the repository:
```sh
git clone https://github.com/yourusername/EnergyApiFunction.git
```
2. Navigate to the project directory:
```sh
cd EnergyApiFunction
```
3. Restore the dependencies:
```sh
dotnet restore
```
### Running the Function
To run the function locally, use the following command:
```sh
dotnet run
```
### Testing TODO
To run the tests, use the following command:
```sh
dotnet test
```
## Contributing
Contributions are welcome! Please fork the repository and create a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
- [Microsoft Learn](https://docs.microsoft.com/en-us/learn/)
- [Azure Functions](https://docs.microsoft.com/en-us/azure/azure-functions/)
TODO:
[ ] Add Tests
[ ] Add React App repo reference