Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lildude/starling-sweeper
💰 Sweep your Starling balance to a savings goal when you get paid.
https://github.com/lildude/starling-sweeper
azure azure-functions golang serverless starlingbank
Last synced: about 1 month ago
JSON representation
💰 Sweep your Starling balance to a savings goal when you get paid.
- Host: GitHub
- URL: https://github.com/lildude/starling-sweeper
- Owner: lildude
- License: mit
- Created: 2022-09-23T14:51:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T13:35:56.000Z (7 months ago)
- Last Synced: 2024-05-01T22:57:42.557Z (7 months ago)
- Topics: azure, azure-functions, golang, serverless, starlingbank
- Language: Go
- Homepage:
- Size: 435 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Starling Sweeper
This application allows you to "sweep" the balance in your account as the time of receiving an inbound faster payment or Nostro deposit to a savings goal.
I run this as an Azure Function but thanks to the way they run, this can be run independently standalone anywhere without any tie-in to the likes of AWS Lamba.
## How it works
1. Starling Bank triggers a webhook on each transaction.
1. This webhook is configured to POST the transaction data to this application running on Azure Functions.
1. The application...
- checks the signature of the request,
- checks the transaction UID and if it's not the transaction we swept last,
- checks the amount is greater than a set threshold,
- checks balance from prior to the incoming,
- and then sends a request back to Starling Bank to move the original balance to a savings goal.
## Examples
### Above Threshold
```
Balance: £200
Threshold: £2000
Incoming payment: £2100
Result: £200 tranferred to goal.
Balance after: £2100
```
### Below Threshold
```
Balance: £200
Threshold: £2000
Incoming payment: £1700
Result: No transfer
Balance after: £1900
```
### Overdrawn
```
Balance: (£100)
Threshold: £2000
Incoming payment: £2300
Result: No transfer
Balance after: £2200
```
## Installation
### Pre-Requisites
- A [Starling Bank](https://starlingbank.com) account.
- A [Starling Bank Developer](https://developer.starlingbank.com) account.
- An [Azure](https://azure.microsoft.com/free/) account.
- A Redis database. I use a free account from [Redis](https://redis.com/try-free/) as it's cheaper than Azure.
### Configuring Your App
- Create your function app:
- in the Azure portal:
How to set up a custom handler Azure Function
Start by searching for Function App in the Azure Portal and click Create.
The important settings for this are below, other settings you can use default or your own preferences.
[Basic]
1. Publish: Code
2. Runtime stack: Custom Handler
3. Version: custom
[Hosting]
1. Operating System: Linux
2. Plan type: Consumption (Serverless)
... or ...
- in [VSCode](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-other?tabs=go%2Clinux#create-the-function-app-in-azure)
- As we're shipping an executable, you will need to use a Azure Service Principal for RBAC for the deployment credentials. Follow [these](https://github.com/Azure/functions-action/blob/d4e7f5d24dc958f6904ffd095fe5033d474abe49/README.md#using-azure-service-principal-for-rbac-as-deployment-credential) instructions.
- Register an application with your Starling developer account.
- Create a personal webhook using the URL from when you created your function app above.
- Make a note of the webhook secret and the personal access token.
- Set the following keys under Settings > Configuration > Application Settings for your function app:
- `WEBHOOK_SECRET` - used to validate inbound requests.
- `PERSONAL_ACCESS_TOKEN` - used to request transfers to savings goal.
- `SWEEP_GOAL` - the target savings goal for sweeps.
- `SWEEP_THRESHOLD` - the threshold, in _pence_, for incoming payments to trigger a sweep.
- `ACCOUNT_UID` - the identifier of the Starling account on which you want this to run.
- `REDIS_URL` - the URL for the Redis database you want to use.
- `FUNCTION_APP` - the name of your Azure Function app.
You should probably use the [Key Vault](https://azure.microsoft.com/services/key-vault/) for all secrets to be extra safe.
- Deploy the application, either using [VSCode](https://docs.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-other?tabs=go%2Clinux#publish-the-project-to-azure) or via GitHub Actions by pushing to `main` or merging a pull request into `main`.
### Local Development and Testing
- [Configure your environment](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-other?tabs=go%2Cmacos#configure-your-environment)
- Save the above settings to a `.env` file.
You can also add these to a `local.settings.json` file by [pulling them from Azure](https://learn.microsoft.com/en-us/azure/azure-functions/functions-develop-vs-code?tabs=csharp#download-settings-from-azure) and later push [push these to Azure when you deploy from VSCode](https://learn.microsoft.com/en-us/azure/azure-functions/functions-develop-vs-code?tabs=csharp#application-settings-in-azure).
**Don't commit either of these files to your repo unless you really don't like your money.**
- Start the application: `make start`.
## Similar Projects
- [Starling Roundup (for AWS)](https://github.com/billglover/starling-roundup) - the origin of the fork of this fork.
- [Starling CoinJar](https://github.com/cooperaj/starling-coinjar)