Skip to content

chore: Update README.md with setup instructions and environment varia… #12

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

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

chore: Update README.md with setup instructions and environment varia… #12

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
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,33 @@

## Running the Application

- Open up your terminal and clone the repository by running
1. **Clone the Repository:**

Open your terminal and run:

```bash
git clone https://github.com/hookdeck/nodejs-webhook-server-example.git
```

- Change into the cloned directory and install the dependencies
2. **Install Dependencies:**

Change into the cloned directory and install the dependencies

```bash
cd nodejs-webhook-server-example
npm install
```
3. **Setup Environment Variables:**

Create a `.env` file and add your [Hookdeck secret](https://dashboard.hookdeck.com/settings/project/secrets) for signature verification

```makefile
HOOKDECK_SIGNING_SECRET=<your_secret_here>
```

4. **Start the Server:**

- Start the server by executing
Start the server by executing

```bash
npm run dev
Expand Down