Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 1.06 KB

Contributing to BashBuddy

How to setup everything:

Basic

Install nvm and pnpm. Install the node version in .nvmrc.

nvm install
pnpm install

Ports

  • Server: 3000

  • Docs: 3001

  • Authenticator: 5173

  • Account: 5174

  • Landing: 5175

  • PostgreSQL: 5432

  • Mailpit:

    • 8025 (Web UI)
    • 1025 (SMTP)

Ngrok

To receive webhooks like google calendar you will need ngrok. (if you just want stripe webhooks you can skip this and check down below)

First create a ngrok account, with a free url.

Then set the env vars from .env.example, and when running server, it will use ngrok to get a public url.

Stripe

First, create a webhook with the following events:

  • checkout.session.completed
  • invoice.paid
  • invoice.payment_failed

Then set the env vars from .env.example, and when running server. You will also need to create a webhook.

Webhook (without ngrok)

You will need the stripe CLI.

stripe login

Then run the following command to create the webhook:

stripe listen --forward-to http://localhost:3001/webhooks/stripe