Skip to content

Commit 37a9ebd

Browse files
lukeguild-quovoluke-guild
authored andcommitted
Update README to provide a link to WSL instructions (#9)
* update README to provide link to WSL instructions * use reference links and add another note to windows users in the Getting Started section
1 parent af74bd4 commit 37a9ebd

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ This is a reference application demonstrating an end-to-end [Plaid][plaid] integ
88

99
## Requirements
1010

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.
1212
- [Plaid API keys][plaid-keys] - [sign up][plaid-signup] for a free Sandbox account if you don't already have one
1313

1414
## Getting Started
1515

16+
Note: We recommend running these commands in a unix terminal. Windows users can use a [WSL][wsl] terminal to access libraries like `make`.
17+
1618
1. Clone the repo.
1719
```shell
1820
git clone https://github.com/plaid/pattern.git
@@ -38,12 +40,13 @@ This is a reference application demonstrating an end-to-end [Plaid][plaid] integ
3840
All available commands can be seen by calling `make help`.
3941
4042
## Architecture
43+
4144
As a modern full-stack application, Pattern consists of multiple services handling different segments of the stack:
4245
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
4750
4851
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.
4952
@@ -84,3 +87,4 @@ See [`docs/troubleshooting.md`][troubleshooting].
8487
[react]: http://reactjs.org/
8588
[server-readme]: server/README.md
8689
[troubleshooting]: docs/troubleshooting.md
90+
[wsl]: https://nickjanetakis.com/blog/setting-up-docker-for-windows-and-wsl-to-work-flawlessly

0 commit comments

Comments
 (0)