Skip to content
An example end-to-end Plaid integration to create items and fetch transaction data
JavaScript CSS PLpgSQL Shell Makefile HTML Dockerfile
Branch: master
Clone or download
Latest commit 72d7fe9 Sep 3, 2019

README.md

Plaid Pattern

Plaid Pattern client

This is a reference application demonstrating an end-to-end Plaid integration, focused on linking items and fetching transaction data.

This is not meant to be run as a production application.

Requirements

  • Docker Version 2.0.0.3 (31259) or higher, installed, running, and signed in. If you're on Windows, check out this link to get set up in WSL.
  • Plaid API keys - sign up for a free Sandbox account if you don't already have one

Getting Started

Note: We recommend running these commands in a unix terminal. Windows users can use a WSL terminal to access libraries like make.

  1. Clone the repo.
    git clone https://github.com/plaid/pattern.git
    cd pattern
  2. Create the .env file.
    cp .env.template .env
  3. Update the .env file with your Plaid API keys.
  4. Start the services. The first run may take a few minutes as Docker images are pulled/built for the first time.
    make start
  5. Open http://localhost:3000 in a web browser.
  6. When you're finished, stop the services.
    make stop

Additional Commands

All available commands can be seen by calling make help.

Architecture

As a modern full-stack application, Pattern consists of multiple services handling different segments of the stack:

We use Docker Compose to orchestrate these services. As such, each individual service has its own Dockerfile, which Docker Compose reads when bringing up the services.

For more information about the individual services, see their readmes, linked in the list above.

Troubleshooting

See docs/troubleshooting.md.

Additional Resources

License

MIT

You can’t perform that action at this time.