Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add webhook info to readme #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add webhook info to readme #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,15 @@ Includes:
```
## Getting Started

Ensure you have nodejs and docker installed on your workstation.
To run locally, spin up a local webhook using [ngrok](https://ngrok.com/):
1. [Download](https://ngrok.com/download) and install ngrok
2. Start ngrok to create a public URL for your localhost. Replace 3000 with your local server's port if it differs.
```
ngrok http 3000
```
3. Note the Forwarding URL (e.g. https://yoursubdomain.ngrok.ioor yoursubdomain.ngrok-free.app) for configuring the webhook (see https://docs.holaplex.dev/hub/Guides/hosting-locally)

To spin up the app, ensure you have nodejs and docker installed on your workstation. Then:

```
# start postgres in a docker container
Expand Down