Need help with pattern?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

plaid
145 Stars 84 Forks MIT License 35 Commits 16 Opened issues

Description

An example end-to-end Plaid integration to create items and fetch transaction data

Services available

!
?

Need anything else?

Contributors list

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.
    shell
    git clone https://github.com/plaid/pattern.git
    cd pattern
    
  2. Create the
    .env
    file.
    shell
    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.
    shell
    make start
    
  5. Open http://localhost:3000 in a web browser.
  6. When you're finished, stop the services.
    shell
    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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.