README.md

Backfeed API

Backfeed is an open-source feedback reporting platform.

Local Development

First, cp .env.local.template .env.local and fill in the values.

Building and Running

Install dependencies:

bun install

Setup the database (only required once, to create the database):

bun db:setup

Run database migrations:

bun db:migrate

Run the dev server:

bun run dev

Webhooks (Payments)

Our Backfeed payment processor, Stripe, issues webhooks. Webhooks are used in this project for realtime updates. Webhook events can be received locally through the following steps:

First, follow the steps to download the Stripe CLI and authenticate at the Stripe CLI installation guide.

Note

If you are completing the login through the browser, make sure you are currently signed in through the proper environment as each environment exposes its own API key.

Once logged in with the Stripe CLI, stripe listen will work in the webhooks listener resource in Tilt, which creates a tunnel for local webhook testing. The output of this provides a webhook signing secret, which you need to fill in the STRIPE_WEBHOOK_SECRET environment variable.

From there, webhook events will be forwarded to the local listener. You can manage the events within the webhooks route under the /webhooks/stripe endpoint found in src/server.ts.

License

The code in this repository is licensed under MIT, © Omni LLC. See LICENSE.md for more information.