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 and running
• Plaid API keys - sign up for a free Sandbox account if you don't already have one

Getting Started

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

For more information about the individual services, see the readmes for the client, database, and server.

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