diff --git a/README.md b/README.md index a3c8eca8..7ca30122 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,19 @@ yarn prisma:seed yarn dev ``` +## Set Up Ngrok + +External data providers require HTTPS/SSL webhook URLs for sending data. + +To test this locally/during development, you will need to setup `ngrok`. + +1. Visit [ngrok.com](https://ngrok.com/) +2. Create a free account +3. Visit [this page](https://dashboard.ngrok.com/get-started/your-authtoken) to access your auth token +4. Paste it into your `.env` file: `NGROK_AUTH_TOKEN={your_auth_token}` + +That's it! As long as you run the project locally using `docker` with `yarn dev:services:all` you'll be good to go. + ## Contributing To contribute, please see our [contribution guide](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md).