https://github.com/rgee0/postcodedaylight
Simple example program for use with OpenFaaS - https://github.com/openfaas/faas. Supply a UK postcode to find the remaining hours of daylight.
https://github.com/rgee0/postcodedaylight
faas functions golang openfaas serverless
Last synced: 6 months ago
JSON representation
Simple example program for use with OpenFaaS - https://github.com/openfaas/faas. Supply a UK postcode to find the remaining hours of daylight.
- Host: GitHub
- URL: https://github.com/rgee0/postcodedaylight
- Owner: rgee0
- License: mit
- Created: 2017-06-02T22:39:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-18T18:51:31.000Z (about 8 years ago)
- Last Synced: 2025-02-05T15:12:27.958Z (8 months ago)
- Topics: faas, functions, golang, openfaas, serverless
- Language: Go
- Homepage:
- Size: 7.81 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/rgee0/postcodedaylight)
# postcodedaylight
Sample function used to evaluate [faas](https://github.com/alexellis/faas) from [get-faas.com](http://docs.get-faas.com/). The function accepts a UK postcode and returns the daylight hours for that place using a combination of endpoints offered by [postcodes.io](https://postcodes.io) and [sunrise-sunset.org](https://sunrise-sunset.org/api). [sunrise-sunset.org](https://sunrise-sunset.org/api) do ask that usage is kept at 'reasonable request volumes' and that attribution to them be shown; please bear this in mind if using downstream.
You can execute the function like this:
`curl http://localhost:8080/function/func_postcodedaylight -d "SW1A 1AA"`
(or use the [FaaS UI](http://localhost:8080/ui/) to pass the postcode as text)
The response for a valid UK postcode should look like this:
`Duration of daylight today at SW1A1AA : 16h25m34s (4h28m46s until sunset).`
## Installation
You can either install `postcodedaylight` via your FaaS compose file or you can add it via the UI.
### Compose file
Add this to your FaaS `docker-compose.yml`
```
# Returns the amount of daylight to expect for a given postcode
postcodedaylight:
image: rgee0/postcodedaylight:latest
labels:
function: "true"
depends_on:
- gateway
networks:
- functions
environment:
fprocess: "/go/bin/postcodedaylight"
no_proxy: "gateway"
https_proxy: $https_proxy
```
and then redeploy the FaaS func stack
`docker stack deploy -c docker-compose.yml func`
n.b. Remember to change the image to `rgee0/postcodedaylight:latest-armhf` if running on a Raspberry Pi.
### UI
Use the `CREATE NEW FUNCTION` link and add these details:
- Image: `rgee0/postcodedaylight:latest`
- Service name: `func_postcodedaylight`
- fProcess: `/go/bin/postcodedaylight`
- Network: `func_functions`