sls-ynab-stock-updates

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #android #machine-learning #linux #docker #macos #nodejs #java #security #pytorch #open-source

sls-ynab-stock-updates

(★ 17)

Serverless function to automatically update balance of investment accounts in YNAB

sls-ynab-stock-updates 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sls-ynab-stock-updates

[![Deploy](https://github.com/MatissJanis/sls-ynab-stock-updates/actions/workflows/deploy.yaml/badge.svg)](https://github.com/MatissJanis/sls-ynab-stock-updates/actions/workflows/deploy.yaml)

Serverless function to automatically update investment account balances in YNAB. If the assets are in multiple currencies - tries it's best to convert to the accounts base currency.

## Requirements

- Node
- NPM

## Installation

```sh
npm install
```

## Setup

There are a few preliminary steps that must be taken to start using this serverless function.

1. Add information about your portfolio to the YNAB accounts you would like to be tracked.

Format: `INVESTMENTS: {Stock Symbol} {Amount}, {Stock Symbol} {Amount}...`

Example: `INVESTMENTS: AAPL 191, MSFT 120`

Crypto example: `INVESTMENTS: BTC-EUR 0.09231, XMR-USD 120.3341`

![](https://raw.githubusercontent.com/MatissJanis/sls-ynab-stock-updates/master/setup.png)

2. Create a `serverless.env.yml` environment variable file and copy the existing variables from the example file.

```sh
cp serverless.env.example.yml serverless.env.yml
```

3. Set the environment variables

- `YNAB_API_TOKEN`: personal API token generated in the [YNAB homepage](https://app.youneedabudget.com/settings/developer).
- `AUTOMATIC_APPROVAL`: should the automatic balance adjustment transactions be auto-approved? Useful to set this to `true` if you are running this function hourly/daily/weekly/etc and don't want to go through streams of transactions.
- `AUTOMATIC_CURRENCY_CONVERSION`: should automatic currency conversion be turned on? Converts to budgets base currency. Useful if, you have assets in multiple currencies and they are all in one account.
- `ALARM_EMAIL`: what email should be notified if the function starts malfunctioning and throwing errors?

4. Deploy the function

```sh
npm run deploy
```

## Development

1. Define necessary env variables in `serverless.env.yml` (example available in `serverless.env.example.yml`)

2. Run (to run locally)

```sh
npm start
```

## Deployment

If you wish to run this serverless function on a schedule (configured in `serverless.yml` file), then it must be deployed. This can be done by running the following command.

```sh
npm run deploy
```

sls-ynab-stock-updates

sls-ynab-stock-updates 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

sls-ynab-stock-updates

sls-ynab-stock-updates 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README