https://github.com/modrev-ai/plaid-transaction
Use of Plaid to access bank transaction history
https://github.com/modrev-ai/plaid-transaction
docker docker-compose fintech plaid typescript
Last synced: about 2 months ago
JSON representation
Use of Plaid to access bank transaction history
- Host: GitHub
- URL: https://github.com/modrev-ai/plaid-transaction
- Owner: modrev-ai
- License: mit
- Created: 2022-01-31T03:16:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-01T02:07:25.000Z (over 3 years ago)
- Last Synced: 2025-08-17T20:44:22.528Z (11 months ago)
- Topics: docker, docker-compose, fintech, plaid, typescript
- Language: TypeScript
- Homepage:
- Size: 1.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Plaid Bank Transaction Dashboard
Plaid is an app which allows 3rd party connection to many banking institutions. The merit of this app is the functionality that makes multi-access possible.
Further, the app conveniently extracts transaction histories of each account, which is the primary reason for me to study Plaid for my personal finance organization.
## Environment
Current app was tested in Ubuntu 20.04. Also required is up-to-date Docker for installation.
## Installation
1. Set up dotenv file for log in credential
```
cp .env.template .env
```
- Setting up dotenv file
- Initially we have to create an environment file for login credential. Simple use .env.template and create .env file. The `PLAID_CLIENT_ID` and `PLAID_SECRET_KEYS` can be found on the [key](https://dashboard.plaid.com/team/keys) section of the Plaid dashboard.
- `PLAID_ENV` takes either `sandbox` or `development`. In order to actually test the connection to banking institutions, the app has to be loaded as a dev mode, otherwise it will throw credential error when prompted.
- `REDIRECT_URI` must be matched to the receiving end of the Plaid server. If not deploying for actual service, the local address (https://localhost:3001/oauth-link) is used here. It can be set from the [api](https://dashboard.plaid.com/team/api) section of the Plaid dashboard. Note that as opposed to Plaid tutorial, the address is secure protocol is used (i.e., https instead of http).
* When run locally, or has any issue with authentification, leave the redirect empty
2. Pull docker image (note that sudo is used in case base environment is used)
```
sudo make start
```
3. Open https://localhost:3001
4. For closing service, use the following command
```
sudo make stop
```
## Additional Information
* More in-depth explanation can be found from the [original Plaid manual](pattern-readme.md)
* Other nfcu projects are found [here](https://github.com/morissette/nfcu) and [here](https://github.com/tjhorner/node-nfcu)