Skip to content

Latest commit

 

History

History
120 lines (74 loc) · 3.55 KB

README.md

File metadata and controls

120 lines (74 loc) · 3.55 KB

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:


Screenshot of UnWebhook

About

A simple tool for working with webhooks. Great for teams and staging environments.

Watch the introduction video on youtube

Capabilities

  • add multiple endpoints
  • save received messages (for 7 days)
  • automatically forward incoming messages to one or more destinations
  • choose forwarding strategy (send to: first in list, all in list)
  • support fallback forwarding (if first is down, forward to next)
  • replay webhook delivery (resend the data to destinations)

Want to send messages to your local machine and need a tunnel? Check out untun by the UnJs team


Tech Stack

UnWebhook is built with the following epic technologies & tools:

Running Locally

To get a local copy up and running, follow these simple steps.

Prerequisites

Here is what you need to be able to run UnInbox locally.

Setup

  1. Clone the repo into a public GitHub repository (or fork https://github.com/un/webhook-proxy/fork).

    git clone https://github.com/un/webhook-proxy.git UnWebhook

    If you are on Windows, run the following command on gitbash with admin privileges:
    > git clone -c core.symlinks=true https://github.com/un/webhook-proxy.git
    See docs for more details.

  2. Go to the project folder

    cd UnWebhook
  3. Check and install the correct node/pnpm versions

    nvm install
  4. Install packages with pnpm

    pnpm i
  5. Set up your .env file

    • Duplicate .env.example to .env. This file is already pre-configured for use with the local docker containers

      mac

       cp .env.example .env

      windows

       copy .env.example .env
  6. Set your env variables

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.