quickstart

(โ˜… 741)

Get up and running with Plaid Link and the API in minutes

  • .env.example
  • .gitignore
  • LICENSE
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/plaid/quickstart

Downloads the entire project code from GitHub to your computer.

cd quickstart

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install mkcert

Installs the pre-built package via Homebrew โ€” no source build required.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
mvn clean package

Installs dependencies and builds the project using Maven.

โœ… A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
$ npm install

Downloads and installs the libraries listed in package.json.

npm ci

Type this command into your terminal and run it.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip3 install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build

Compiles the Go program into an executable.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

7. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
bundle

Type this command into your terminal and run it.

โœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

// repository documentation