Docker/Maybe
Docker/Maybe
1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-08-09 15:35:22 +02:00
Code Issues Releases Activity Actions

Add ngrok instructions

Browse source
This commit is contained in:
David Neuman 2024-01-16 14:41:36 -05:00
parent 2b7924247e
commit 27f810c230
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -63,6 +63,19 @@ yarn prisma:seed
yarn dev 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 ## Contributing
To contribute, please see our [contribution guide](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md). To contribute, please see our [contribution guide](https://github.com/maybe-finance/maybe/blob/main/CONTRIBUTING.md).