You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,13 @@ This is a reference application demonstrating an end-to-end [Plaid][plaid] integ
8
8
9
9
## Requirements
10
10
11
-
-[Docker][docker] Version 2.0.0.3 (31259) or higher, installed, running, and signed in
11
+
-[Docker][docker] Version 2.0.0.3 (31259) or higher, installed, running, and signed in. If you're on **Windows**, check out [this link][wsl] to get set up in WSL.
12
12
-[Plaid API keys][plaid-keys] - [sign up][plaid-signup] for a free Sandbox account if you don't already have one
13
13
14
14
## Getting Started
15
15
16
+
Note: We recommend running these commands in a unix terminal. Windows users can use a [WSL][wsl] terminal to access libraries like `make`.
@@ -38,12 +40,13 @@ This is a reference application demonstrating an end-to-end [Plaid][plaid] integ
38
40
All available commands can be seen by calling `make help`.
39
41
40
42
## Architecture
43
+
41
44
As a modern full-stack application, Pattern consists of multiple services handling different segments of the stack:
42
45
43
-
- [`database`][database-readme] runs a [PostgreSQL][postgres] database
44
-
- [`server`][server-readme] runs an application back-end server using [NodeJS] and [Express]
45
-
- [`client`][client-readme] runs a [React]-based single-page web frontend
46
-
- [`ngrok`][ngrok-readme] exposes a [ngrok] tunnel from your local machine to the Internet to receive webhooks
46
+
- [`database`][database-readme] runs a [PostgreSQL][postgres] database
47
+
- [`server`][server-readme] runs an application back-end server using [NodeJS] and [Express]
48
+
- [`client`][client-readme] runs a [React]-based single-page web frontend
49
+
- [`ngrok`][ngrok-readme] exposes a [ngrok] tunnel from your local machine to the Internet to receive webhooks
47
50
48
51
We use [Docker Compose][docker-compose] to orchestrate these services. As such, each individual service has its own Dockerfile, which Docker Compose reads when bringing up the services.
49
52
@@ -84,3 +87,4 @@ See [`docs/troubleshooting.md`][troubleshooting].
0 commit comments