Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
aklarfeld committed Jul 7, 2023
1 parent 58bb25f commit e4f7db6
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Supergood GoLang Example Code

This is a simple example of how to integrate the Supergood GoLang client on the Plaid Quickstart Server. This example is meant to be used as a reference and not as a production-ready application.

## Running the Example Code

1. Navigate to `.env` and add the following env variables. Reach out to [email protected] if you need any of these keys:
- `PLAID_CLIENT_ID` (at the top of the file)
- `PLAID_SECRET` (at the top of the file)
- `SUPERGOOD_CLIENT_ID` (at the bottom of the file)
- `SUPERGOOD_CLIENT_SECRET` (at the bottom of the file)
2. Navigate to `./frontend` and run `yarn install` and then `yarn start` to start the frontend.
3. Run `./start.sh` to start the backend.
4. Refresh the local server browser and you should see a prompt to log in with Plaid. Click the button and choose any bank to connect. The username and password for every integration is `user_good` and `pass_good`.
5. Make some API calls and you should start seeing them populate in the [Supergood dashboard](https://dashboard.supergood.ai/).

## How it Works

The Supergood library is included in `server.py` on line 59 and the initialization call is done on line 62.

There are several optional configuration options that can be passed into the Supergood client. These are documented in the [Python SDK](https://docs.supergood.ai/integrate-with-clients/python). The options included in this demonstration allow the request bodies to be logged for billing tracking and debugging purposes, but all data is completely redacted on the client.

0 comments on commit e4f7db6

Please sign in to comment.