From bb1884064d2897b2f2211a0edc862652601a380a Mon Sep 17 00:00:00 2001 From: Tyler Myracle Date: Wed, 17 Jan 2024 20:48:09 -0600 Subject: [PATCH] add Teller info to README --- .env.example | 4 ++-- README.md | 8 ++++++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.env.example b/.env.example index 12baaedb..8cb427a1 100644 --- a/.env.example +++ b/.env.example @@ -35,9 +35,9 @@ NX_POLYGON_API_KEY= # We use Teller.io for automated banking data. You can sign up for a free # account and get a free API key at https://teller.io NX_TELLER_SIGNING_SECRET= -NX_TELLER_ENV=sandbox -NEXT_PUBLIC_TELLER_ENV=sandbox NEXT_PUBLIC_TELLER_APP_ID= +NEXT_PUBLIC_TELLER_ENV=sandbox +NX_TELLER_ENV=sandbox ######################################################################## # EMAIL diff --git a/README.md b/README.md index a3c8eca8..41debdf2 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,14 @@ Then, create a new secret using `openssl rand -base64 32` and populate `NEXTAUTH To enable transactional emails, you'll need to create a [Postmark](https://postmarkapp.com/) account and add your API key to your `.env` file (`NX_POSTMARK_API_TOKEN`). You can also set the from and reply-to email addresses (`NX_POSTMARK_FROM_ADDRESS` and `NX_POSTMARK_REPLY_TO_ADDRESS`). If you want to run the app without email, you can set `NX_POSTMARK_API_TOKEN` to a dummy value. +Maybe uses [Teller](https://teller.io/) for connecting financial accounts. To get started with Teller, you'll need to create an account. Once you've created an account: + +- Add your Teller application id to your `.env` file (`NEXT_PUBLIC_TELLER_APP_ID`). +- Download your authentication certificates from Teller, create a `certs` folder in the root of the project, and place your certs in that directory. You should have both a `certificate.pem` and `private_key.pem`. **NEVER** check these files into source control, the `.gitignore` file will prevent the `certs/` directory from being added, but please double check. +- Set your `NEXT_PUBLIC_TELLER_ENV` and `NX_TELLER_ENV` to your desired environment. The default is `sandbox` which allows for testing with mock data. The login credentials for the sandbox environment are `username` and `password`. To connect to real financial accounts, you'll need to use the `development` environment. +- Webhooks are not implemented yet, but you can populate the `NX_TELLER_SIGNING_SECRET` with the value from your Teller account. +- We highly recommend checking out the [Teller docs](https://teller.io/docs) for more info. + Then run the following yarn commands: ```