Plaid Pattern

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:

• database

  runs a PostgreSQL database

• server

  runs an application back-end server using NodeJS and Express

• client

  runs a React-based single-page web frontend

• ngrok

  exposes a ngrok tunnel from your local machine to the Internet to receive webhooks

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

• For an overview of the Plaid platform and products, refer to this Quickstart guide.
• Check out this high-level introduction to Plaid Link.
• Find comprehensive information on Plaid API endpoints in the API documentation.
• Questions? Please head to the Help Center or open a Support ticket.

License

MIT